更新时间:2023-11-21 GMT+08:00

查询复制对列表

功能介绍

查询指定保护组下的所有复制对列表,如果不给定指定保护组则查询当前租户下的所有复制对列表。

约束与限制

URI

  • URI格式

    GET /v1/{project_id}/replications

  • 参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

    获取方法请参见获取项目ID

  • Request filter参数说明

    参数名

    是否必选

    参数类型

    说明

    server_group_id

    String

    保护组的ID。

    可通过查询保护组列表接口获取。

    server_group_ids

    Array of strings

    保护组的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”会被忽略。

    protected_instance_id

    String

    保护实例的ID。

    可通过查询保护实例列表接口获取。

    protected_instance_ids

    Array of strings

    保护实例的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”会被忽略。

    name

    String

    复制对的名称。支持模糊查询。

    status

    String

    复制对的状态。

    详细信息可参考复制对状态

    limit

    Integer

    每次请求返回结果个数限制,取值范围为[0,1000]的正整数,默认值为1000。

    offset

    Integer

    每次请求开始的下标,即偏移量,默认值为0。offset必须为数字,不能为负数。

    query_type

    String

    查询场景类型。

    • 如需查询异常状态的复制对列表,query_type的值为“status_abnormal”。
    • 否则,query_type取值为空或“general”。

    availability_zone

    String

    复制对所在的保护组的当前生产站点可用区。

    可通过查询双活域接口获取。

    volume_id

    String

    复制对使用的云硬盘ID。

请求消息

  • 请求参数

  • 请求样例
    https://{Endpoint}/v1/{project_id}/replications?server_group_ids=%5b%2221d65fa4-430e-4761-b9ad-4e27364f874c%22%2c%22943c7d15-0371-4b89-b1a6-db1ef35c9263&status=available

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

响应

  • 要素说明

    参数名称

    参数类型

    说明

    replications

    Array of objects

    复制对列表。

    详情请参见表1

    count

    Integer

    列表中包含的复制对个数。

    表1 replications字段说明

    参数名称

    参数类型

    说明

    id

    String

    复制对的ID。

    name

    String

    复制对的名称。

    description

    String

    复制对的描述。

    replication_model

    String

    复制对的复制类型。默认值为“hypermetro”,表示同步复制。

    status

    String

    复制对的状态。

    详细信息可参考复制对状态

    progress

    Integer

    复制对的同步进度。

    单位:百分比(%)。

    replication_status

    String

    数据同步状态。

    • active:表示数据已同步完成。
    • inactive:表示数据未同步。
    • copying:表示数据正在同步。
    • active-stopped:表示数据已停止同步。

    attachment

    Array of objects

    挂载点。

    详情请参见表2

    server_group_id

    String

    保护组的ID。

    volume_ids

    String

    复制对使用的云硬盘ID。

    priority_station

    String

    标识复制对所在保护组的当前生产站点可用区。

    • source:表示当前生产站点可用区为保护组source_availability_zone的值。
    • target:表示当前生产站点可用区为保护组target_availability_zone的值。

    fault_level

    String

    复制对的故障等级。

    • 0:表示无故障。
    • 2:表示当前生产站点的云硬盘无读写数据权限,此时建议执行故障切换操作。
    • 5:表示复制链路已断,不能执行故障切换操作,需联系客服人员

    created_at

    String

    创建时间。

    默认格式为:"yyyy-MM-ddTHH:mm:ss.SSSSSS",例如:"2019-04-01T12:00:00.000000"

    updated_at

    String

    更新时间。

    默认格式为:"yyyy-MM-ddTHH:mm:ss.SSSSSS",例如:"2019-04-01T12:00:00.000000"

    record_metadata

    Object

    复制对的话单数据。

    详情请参见表3

    failure_detail

    String

    仅在复制对的状态“status”为“error”时,返回的错误码。

    详见错误码的返回值。

    表2 attachment字段说明

    参数名称

    参数类型

    说明

    device

    String

    挂载点。

    protected_instance

    String

    该复制对挂载的保护实例ID。

    表3 record_metadata字段说明

    参数名称

    参数类型

    说明

    multiattach

    Boolean

    复制对中的云硬盘是否为共享云硬盘。

    bootable

    Boolean

    复制对中的云硬盘是否为系统盘。

    volume_size

    Integer

    复制对中的云硬盘容量。单位:GB

    volume_type

    String

    复制对中的云硬盘类型。

    目前支持“SSD”,“GPSSD”和“SAS”三种。
    • “SSD”为超高IO云硬盘
    • “GPSSD”为通用型SSD云硬盘
    • “SAS”为高IO云硬盘
  • 响应样例
    {
        "count": 1,
        "replications": [
            {
                "id": "b93bc1c4-67ee-45a1-bc8a-d022fdd28811",
                "name": "test_replication_name",
                "description": "description_test",
                "replication_model": "hypermetro",
                "status": "available",
                "progress": 0,
                "replication_status": "active",
                "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"
                }
            }
        ]
    }

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

    网关超时。