查询保护实例列表

功能介绍

查询当前租户下的所有保护实例列表。

约束与限制

无

URI

• URI格式

  GET /v1/{project_id}/protected-instances

• 参数说明

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目ID。 获取方法请参见获取项目ID。

请求

• 请求参数

  无

• 请求样例

  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&status=available

  

  使用server_group_ids或protected_instance_ids时，请采用URL编码。

响应

• 要素说明

  参数名称	参数类型	说明
  protected_instances	Array of objects	保护实例的信息列表。 详情请参见表1。
  count	Integer	列表中包含的保护实例个数。

  表1 protected_instances字段说明

  参数名称	参数类型	说明
  id	String	保护实例的ID。
  name	String	保护实例的名称。
  description	String	保护实例的描述。
  server_group_id	String	保护组的ID。
  status	String	保护实例的状态。 具体请参见保护实例状态。
  progress	Integer	保护实例的同步进度。 单位：百分比（%）。
  source_server	String	生产站点云服务器ID。
  target_server	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"。
  priority_station	String	标识保护实例所在保护组的当前生产站点可用区。 source：表示当前生产站点可用区为保护组source_availability_zone的值。 target：表示当前生产站点可用区为保护组的target_availability_zone的值。
  attachment	Array of objects	挂载的复制对列表。 字段说明见表2。
  tags	Array of objects	标签列表。 字段说明见表3。
  metadata	Object	保护实例元数据信息。 具体请参见表4。

  表2 attachment字段说明

  参数名称	参数类型	说明
  replication	String	复制对ID。
  device	String	挂载点。

  表3 tags字段说明

  参数说明	参数类型	说明
  key	String	标签的键。
  value	String	标签的值。

  表4 metadata字段说明

  参数名称	参数类型	说明
  __system__frozen	String	保护实例元数据中资源冻结的字段。 true：表示资源被冻结。 空：表示资源没有被冻结。

• 响应样例

  {
      "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
  }

  或

  { 
       "error": { 
           "message": "XXXX",  
           "code": "XXX" 
       } 
   }

  其中error是泛指的错误，有badrequest、itemNotFound等，如报错为：

  { 
       "badrequest": { 
           "message": "XXXX",  
           "code": "XXX" 
       } 
   }

返回值

• 正常

  返回值	说明
  200	服务器已接受请求。

• 异常

  返回值	说明
  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	网关超时。