# 查询保护实例列表 - ListProtectedInstances #### 功能介绍 查询当前租户下的所有保护实例列表。 #### 接口约束 无 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SDRS/doc?api=ListProtectedInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v1/{project_id}/protected-instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | availability_zone | 否 | String | 保护实例所在的保护组的当前生产站点可用区。 | | limit | 否 | Integer | 每次请求返回结果个数限制，取值范围为\[0,1000\]的正整数，默认值为1000。 最小值：**0** 最大值：**1000** 缺省值：**1000** | | name | 否 | String | 保护实例的名称。支持模糊查询。 | | offset | 否 | Integer | 每次请求开始的下标，即偏移量，默认值为0。offset必须为数字，不能为负数。 最小值：**0** 缺省值：**0** | | 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对应的所有保护实例列表。如果"server_group_id"或者"server_group_ids"查询参数存在时，"protected_instance_ids"会被忽略。 | | query_type | 否 | String | 查询场景类型。status_abnormal：表示查询异常状态的保护实例列表。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编码进行转换。返回"server_group_ids"中有效server_group_id的所有保护实例列表，无效的server_group_id会被忽略。支持查询最多30个server_group_id对应的所有保护实例列表。如果"server_group_id"和"server_group_ids"查询参数同时存在，"server_group_id"会被忽略。 | | status | 否 | String | 保护实例状态。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | protected_instances | Array of [ShowProtectedInstanceParams] objects | 保护实例的信息列表。 | | count | Integer | 列表中包含的保护实例个数。 | 表5ShowProtectedInstanceParams | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 保护实例的ID。 | | name | String | 保护实例的名称。 | | description | String | 保护实例的描述。 | | status | String | 保护实例的状态。 | | source_server | String | 生产站点云服务器ID。 | | target_server | String | 容灾站点云服务器ID。 | | server_group_id | String | 保护组的ID。 | | created_at | String | 创建时间。默认格式为："yyyy-MM-dd HH:mm:ss.SSS"，例："2019-04-01 12:00:00.000"。 | | updated_at | String | 更新时间。默认格式为："yyyy-MM-dd HH:mm:ss.SSS"，例："2019-04-01 12:00:00.000"。 | | metadata | [MetadataParams] object | 保护实例元数据信息。 | | attachment | Array of [ProtectedInstanceAttachment] objects | 挂载的复制对列表。 | | tags | Array of [ResourceTag] objects | 标签列表。 | | progress | Integer | 保护实例的同步进度。单位：百分比（%）。 | | priority_station | String | 标识保护实例所在保护组的当前生产站点可用区。source：表示当前生产站点可用区为保护组source_availability_zone的值。target：表示当前生产站点可用区为保护组的target_availability_zone的值。 | 表6MetadataParams | 参数 | 参数类型 | 描述 | |:---|:---|:---| | __system__frozen | String | 保护实例元数据中资源冻结的字段。 true：表示资源被冻结。 空：表示资源没有被冻结。 | 表7ProtectedInstanceAttachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | replication | String | 复制对ID。 | | device | String | 挂载点。 | 表8ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 键。同一资源的key值不能重复。最大长度为36个UNICODE字符。key不能为空，不允许为空字符串。不能包含以下字符：非打印字符ASCII(0-31)特殊字符"\*","\<","\>","\\","=",",","\|","/"键。不能为空。对于同一资源键值唯一。 | | value | String | 值。最大长度为43个UNICODE字符。value不能为空，可以为空字符串。不能包含以下字符：非打印字符ASCII(0-31)特殊字符"\*","\<","\>","\\","=",",","\|","/"。长度不超过43个字符。 | **状态码： 400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表10ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表12ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 403** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表14ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 404** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表16ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 405** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表18ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 406** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表20ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 407** 表21响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表22ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 408** 表23响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表24ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 409** 表25响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表26ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 500** 表27响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表28ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 501** 表29响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表30ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 502** 表31响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表32ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 503** 表33响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表34ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | **状态码： 504** 表35响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrorInfo] object | 失败返回结构 | 表36ErrorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | message | String | 错误信息 | | code | String | 错误码 | #### 请求示例 说明:使用server_group_ids或protected_instance_ids时，请采用URL编码。 ``` GET https://{Endpoint}/v1/{project_id}/protected-instances?server_group_ids=%5b%2221d65fa4-430e-4761-b9ad-4e27364f874c%22%2c%22943c7d15-0371-4b89-b1a6-db1ef35c9263%22%5d ``` #### 响应示例 **状态码： 200** OK ``` { "protected_instances" : [ { "id" : "67a2cc7e-fb87-41a8-ba28-9c032abcaee1", "name" : "protected_instance_xff", "description" : "protected_instance_xff", "server_group_id" : "21d65fa4-430e-4761-b9ad-4e27364f874c", "status" : "available", "progress" : 0, "source_server" : "d1e8e8a7-ae6f-4f40-bead-20093976961e", "target_server" : "9bad52b9-ca5a-4274-ba9e-3c8ca9843fa1", "created_at" : "2018-11-06 11:09:25.861", "updated_at" : "2018-11-06 11:12:11.716", "priority_station" : "source", "attachment" : [ { "replication" : "08d6b5a0-9a12-4263-a468-30d71d10498c", "device" : "/dev/vdb" }, { "replication" : "4c332757-dc77-458d-9883-03d701cde2f2", "device" : "/dev/vda" } ], "tags" : [ { "key" : "aaaaaaa", "value" : "01234567889" }, { "key" : "ffffff", "value" : "dddd" } ], "metadata" : { } }, { "id" : "50f5091e-9e9e-473c-a932-2a2cbcbeb1ff", "name" : "ecs_sdrs_test", "description" : "1111", "server_group_id" : "943c7d15-0371-4b89-b1a6-db1ef35c9263", "status" : "protected", "progress" : 100, "source_server" : "5fb92d6c-b0cb-46c9-824b-b90ec5500ae6", "target_server" : "c6c0ff54-fa1f-43ef-9ccc-1774e40c8745", "created_at" : "2018-11-06 09:27:52.258", "updated_at" : "2018-11-06 09:44:59.853", "priority_station" : "target", "attachment" : [ { "replication" : "6568f7c4-0510-4f39-929d-8ffccbd4fd47", "device" : "/dev/vda" } ], "tags" : [ { "key" : "aaaaaaa", "value" : "01234567889" }, { "key" : "ffffff", "value" : "dddd" } ], "metadata" : { } } ], "count" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sdrs/ErrorCode.html)。