查询复制对列表
功能介绍
查询指定保护组下的所有复制对列表,如果不给定指定保护组则查询当前租户下的所有复制对列表。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/replications
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
availability_zone |
否 |
String |
复制对所在的保护组的当前生产站点可用区。 |
limit |
否 |
Integer |
每次请求返回结果个数限制,取值范围为[0,1000]的正整数,默认值为1000。 最小值:0 最大值:1000 缺省值:1000 |
name |
否 |
String |
复制对的名称。支持模糊查询。 |
offset |
否 |
Integer |
每次请求开始的下标,即偏移量,默认值为0。offset必须为数字,不能为负数。 最小值: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编码进行转换。返回“protected_instance_ids”中有效protected_instance_id的复制对列表,无效的protected_instance_id会被忽略。支持查询最多30个protected_instance_id对应的复制对列表。如果“protected_instance_id”和“protected_instance_ids”查询参数同时存在,“protected_instance_id”会被忽略。 |
query_type |
否 |
String |
查询场景类型。如需查询异常状态的复制对列表,query_type的值为“status_abnormal”。否则,query_type取值为空或“general”。 枚举值:
|
server_group_id |
否 |
String |
保护组的ID。 |
server_group_ids |
否 |
String |
保护组的ID列表,格式为server_group_ids=['server_group_id1','server_group_id2',...,'server_group_idx'],请使用URL编码进行转换。返回“server_group_ids”中有效server_group_id的复制对列表,无效的server_group_id会被忽略。支持查询最多30个server_group_id对应的复制对列表。如果“server_group_id”和“server_group_ids”查询参数同时存在,“server_group_id”会被忽略。 |
status |
否 |
String |
复制对的状态。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
replications |
Array of ShowReplicationParams objects |
复制对列表。 |
count |
Integer |
列表中包含的复制对个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
复制对的ID。 |
name |
String |
复制对的名称。 |
description |
String |
复制对的描述。 |
status |
String |
复制对的状态。 |
volume_ids |
String |
复制对使用的云硬盘ID。 |
attachment |
Array of ReplicationAttachment objects |
挂载点。 |
created_at |
String |
创建时间。默认格式为:"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 |
复制对的复制类型。默认值为“hypermetro”,表示同步复制。 |
progress |
Integer |
复制对的同步进度。单位:百分比(%)。 |
failure_detail |
String |
仅在复制对的状态“status”为“error”时,返回的错误码。 |
record_metadata |
ReplicationRecordMetadata object |
复制对的话单数据。 |
fault_level |
String |
复制对的故障等级。0:表示无故障。2:表示当前生产站点的云硬盘无读写数据权限,此时建议执行故障切换操作。5:表示复制链路已断,不能执行故障切换操作,需联系技术支持工程师。 |
server_group_id |
String |
保护组的ID。 |
priority_station |
String |
标识复制对所在保护组的当前生产站点可用区。source:表示当前生产站点可用区为保护组source_availability_zone的值。target:表示当前生产站点可用区为保护组target_availability_zone的值。 |
replication_status |
String |
数据同步状态。active:表示数据已同步完成。inactive:表示数据未同步。copying:表示数据正在同步。active-stopped:表示数据已停止同步。 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
multiattach |
Boolean |
复制对中的云硬盘是否为共享云硬盘。 |
bootable |
Boolean |
复制对中的云硬盘是否为系统盘。 |
volume_size |
Integer |
复制对中的云硬盘容量。单位:GB |
volume_type |
String |
复制对中的云硬盘类型。SATA:普通IO磁盘类型。SAS:高IO磁盘类型。SSD:超高IO磁盘类型。co-p1:高IO(性能优化I型)uh-l1:超高IO(时延优化)其中co-p1和uh-l1两种云硬盘只能使用在HANA云服务器、HL1型云服务器、HL2型云服务器上。 枚举值:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 405
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 406
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 407
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 408
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 409
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 501
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 503
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorInfo object |
失败返回结构 |
请求示例
GET https://{Endpoint}/v1/{project_id}/replications
响应示例
状态码: 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" } } ] }
状态码
状态码 |
描述 |
---|---|
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 |
错误码
请参见错误码。