華為云計算 云知識 查詢復(fù)制對列表ListReplications
查詢復(fù)制對列表ListReplications

 

功能介紹

查詢指定保護組下的所有復(fù)制對列表,如果不給定指定保護組則查詢當前租戶下的所有復(fù)制對列表。

接口約束

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

GET /v1/{project_id}/replications

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

availability_zone

String

復(fù)制對所在的保護組的當前生產(chǎn)站點可用區(qū)。

limit

Integer

每次請求返回結(jié)果個數(shù)限制,取值范圍為[0,1000]的正整數(shù),默認值為1000。

最小值:0

最大值:1000

缺省值:1000

name

String

復(fù)制對的名稱。支持模糊查詢。

offset

Integer

每次請求開始的下標,即偏移量,默認值為0。offset必須為數(shù)字,不能為負數(shù)。

最小值:0

缺省值:0

protected_instance_id

String

保護實例的ID。

protected_instance_ids

String

保護實例的ID列表,格式為protected_instance_ids=['protected_instance_id1','protected_instance_id2',...,'protected_instance_idx'],請使用URL編碼進行轉(zhuǎn)換。返回“protected_instance_ids”中有效protected_instance_id的復(fù)制對列表,無效的protected_instance_id會被忽略。支持查詢最多30個protected_instance_id對應(yīng)的復(fù)制對列表。如果“protected_instance_id”和“protected_instance_ids”查詢參數(shù)同時存在,“protected_instance_id”會被忽略。

query_type

String

查詢場景類型。如需查詢異常狀態(tài)的復(fù)制對列表,query_type的值為“status_abnormal”。否則,query_type取值為空或“general”。

枚舉值:

  • status_abnormal

  • general

server_group_id

String

保護組的ID。

server_group_ids

String

保護組的ID列表,格式為server_group_ids=['server_group_id1','server_group_id2',...,'server_group_idx'],請使用URL編碼進行轉(zhuǎn)換。返回“server_group_ids”中有效server_group_id的復(fù)制對列表,無效的server_group_id會被忽略。支持查詢最多30個server_group_id對應(yīng)的復(fù)制對列表。如果“server_group_id”和“server_group_ids”查詢參數(shù)同時存在,“server_group_id”會被忽略。

status

String

復(fù)制對的狀態(tài)。

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

replications

Array of ShowReplicationParams objects

復(fù)制對列表。

count

Integer

列表中包含的復(fù)制對個數(shù)。

表5 ShowReplicationParams

參數(shù)

參數(shù)類型

描述

id

String

復(fù)制對的ID。

name

String

復(fù)制對的名稱。

description

String

復(fù)制對的描述。

status

String

復(fù)制對的狀態(tài)。

volume_ids

String

復(fù)制對使用的 云硬盤 ID。

attachment

Array of ReplicationAttachment objects

掛載點。

created_at

String

創(chuàng)建時間。默認格式為:"yyyy-MM-ddTHH:mm:ss.SSSZ",例如:"2019-04-01T12:00:00.000Z"

updated_at

String

更新時間。默認格式為:"yyyy-MM-ddTHH:mm:ss.SSSZ",例如:"2019-04-01T12:00:00.000Z"

replication_model

String

復(fù)制對的復(fù)制類型。默認值為“hypermetro”,表示同步復(fù)制。

progress

Integer

復(fù)制對的同步進度。單位:百分比(%)。

failure_detail

String

僅在復(fù)制對的狀態(tài)“status”為“error”時,返回的錯誤碼。

record_metadata

ReplicationRecordMetadata object

復(fù)制對的話單數(shù)據(jù)。

fault_level

String

復(fù)制對的故障等級。0:表示無故障。2:表示當前生產(chǎn)站點的云硬盤無讀寫數(shù)據(jù)權(quán)限,此時建議執(zhí)行故障切換操作。5:表示復(fù)制鏈路已斷,不能執(zhí)行故障切換操作,需聯(lián)系技術(shù)支持工程師。

server_group_id

String

保護組的ID。

priority_station

String

標識復(fù)制對所在保護組的當前生產(chǎn)站點可用區(qū)。source:表示當前生產(chǎn)站點可用區(qū)為保護組source_availability_zone的值。target:表示當前生產(chǎn)站點可用區(qū)為保護組target_availability_zone的值。

replication_status

String

數(shù)據(jù)同步狀態(tài)。active:表示數(shù)據(jù)已同步完成。inactive:表示數(shù)據(jù)未同步。copying:表示數(shù)據(jù)正在同步。active-stopped:表示數(shù)據(jù)已停止同步。

枚舉值:

  • active

  • inactive

  • copying

  • active-stopped

表6 ReplicationAttachment

參數(shù)

參數(shù)類型

描述

protected_instance

String

該復(fù)制對掛載的保護實例ID。

device

String

掛載點。

表7 ReplicationRecordMetadata

參數(shù)

參數(shù)類型

描述

multiattach

Boolean

復(fù)制對中的云硬盤是否為共享云硬盤。

bootable

Boolean

復(fù)制對中的云硬盤是否為系統(tǒng)盤。

volume_size

Integer

復(fù)制對中的云硬盤容量。單位:GB

volume_type

String

復(fù)制對中的云硬盤類型。SATA:普通IO磁盤類型。SAS:高IO磁盤類型。SSD:超高IO磁盤類型。co-p1:高IO(性能優(yōu)化I型)uh-l1:超高IO(時延優(yōu)化)其中co-p1和uh-l1兩種云硬盤只能使用在HANA 云服務(wù)器 、HL1型云服務(wù)器、HL2型云服務(wù)器上。

枚舉值:

  • SATA

  • SAS

  • SSD

  • co-p1

  • uh-l1

狀態(tài)碼: 400

表8 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表9 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 401

表10 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表11 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 403

表12 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表13 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 404

表14 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表15 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 405

表16 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表17 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 406

表18 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表19 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 407

表20 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表21 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 408

表22 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表23 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 409

表24 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表25 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 500

表26 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表27 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 501

表28 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表29 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 502

表30 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表31 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 503

表32 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表33 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

狀態(tài)碼: 504

表34 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

ErrorInfo object

失敗返回結(jié)構(gòu)

表35 ErrorInfo

參數(shù)

參數(shù)類型

描述

message

String

錯誤信息

code

String

錯誤碼

請求示例

GET https://{Endpoint}/v1/{project_id}/replications

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "count" : 1,
  "replications" : [ {
    "id" : "b93bc1c4-67ee-45a1-bc8a-d022fdd28811",
    "name" : "test_replication_name",
    "description" : "description_test",
    "replication_model" : "hypermetro",
    "status" : "available",
    "progress" : 0,
    "attachment" : [ {
      "device" : "/dev/vda",
      "protected_instance" : "8a7a6339-679b-452b-948c-144e0ef85d9e"
    } ],
    "server_group_id" : "c2aee29a-2959-4d01-9755-01cc76a4d17d",
    "volume_ids" : "48dda0c0-c800-46f2-9728-a519ff783d35,388b324a-a9d1-44a4-a00d-42085f22a9bc",
    "priority_station" : "source",
    "fault_level" : "0",
    "created_at" : "2018-05-04T03:43:24.108526",
    "updated_at" : "2018-05-04T03:44:28.322873",
    "record_metadata" : {
      "multiattach" : false,
      "bootable" : false,
      "volume_size" : 10,
      "volume_type" : "SATA"
    }
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

407

Proxy Authentication Required

408

Request Timeout

409

Conflict

500

Internal Server Error

501

Not Implemented

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

錯誤碼

請參見錯誤碼。