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

查询保护组详情

功能介绍

查询单个保护组的详细信息,如ID、名称等。

约束与限制

URI

  • URI格式

    GET /v1/{project_id}/server-groups/{server_group_id}

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

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

    server_group_id

    String

    保护组的ID。

    具体信息可参考查询保护组列表接口。

请求消息

  • 请求参数

  • 请求样例

    GET https://{Endpoint}/v1/{project_id}/server-groups/decf224d-87fe-403a-8721-037a1a45c287

响应

  • 要素说明

    参数名称

    参数类型

    说明

    server_group

    Object

    保护组的详细信息。

    详情请参见表1

    表1 server_group字段说明

    名称

    参数类型

    说明

    id

    String

    保护组的ID。

    name

    String

    保护组的名称。

    description

    String

    保护组的描述。

    status

    String

    保护组的状态。

    详情请参见保护组状态

    progress

    Integer

    保护组的同步进度。

    单位:百分比(%)。

    source_availability_zone

    String

    保护组创建时的生产站点可用区名称。

    注意:保护组切换、故障切换后,该值不变。

    target_availability_zone

    String

    保护组创建时的容灾站点可用区名称。

    注意:保护组切换、故障切换后,该值不变。

    domain_id

    String

    双活域ID。

    domain_name

    String

    双活域名称。

    priority_station

    String

    用于标识保护组的当前生产站点。

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

    protected_instance_num

    Integer

    该保护组中保护实例的个数。

    replication_num

    Integer

    该保护组中复制对的个数。

    disaster_recovery_drill_num

    Integer

    该保护组中容灾演练的个数。

    protected_status

    String

    保护状态。

    • started:表示该保护组开始保护。
    • stopped:表示该保护组停止保护。
    说明:

    系统近期进行了升级,对于升级后创建的保护组,该字段值为null,无实际意义。

    replication_status

    String

    数据同步状态。

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

    系统近期进行了升级,对于升级后创建的保护组,该字段值为null,无实际意义。

    health_status

    String

    健康状态。

    • normal:表示该保护组处于正常状态。
    • abnormal:表示该保护组处于非正常状态。
    说明:

    系统近期进行了升级,对于升级后创建的保护组,该字段值为null,无实际意义。

    source_vpc_id

    String

    生产站点虚拟私有云ID。

    target_vpc_id

    String

    容灾站点虚拟私有云ID。

    test_vpc_id

    String

    容灾演练虚拟私有云ID。

    说明:

    预留参数,暂未启用。

    dr_type

    String

    部署模式。默认值为“migration”,migration表示VPC内迁移。

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

    protection_type

    String

    保护模式

    • null:表示保护组中所有复制对按照一个整体进行数据同步,不会出现部分同步失败场景。
    • replication-pair:表示保护组中复制对数据同步单独进行,不以整体进行。

    replication_model

    String

    复制类型。

    说明:

    预留参数,暂未启用。

    server_type

    String

    管理的服务器类型。

    • ECS:表示管理的服务器类型为云服务器。
  • 响应样例
    {
        "server_group": {
            "id": "decf224d-87fe-403a-8721-037a1a45c287",
            "name": "Protection-Group-lwx",
            "description": null,
            "source_availability_zone": "cn-north-1a",
            "target_availability_zone": "cn-north-1b",
            "domain_id": "fb4bb8e3-a574-4437-a156-78c916aeea4d",
            "domain_name": "ActiveactiveDomain",
            "status": "available",
            "protected_status": null,
            "replication_status": null,
            "health_status": null,
            "progress": 0,
            "priority_station": "source",
            "protected_instance_num": 0,
            "replication_num": 0,
            "disaster_recovery_drill_num": 0,
            "source_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f",
            "target_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f",
            "test_vpc_id": null,
            "dr_type": "migration",
            "server_type": "ECS",
            "created_at": "2019-05-22 08:16:54.413",
            "updated_at": "2019-05-23 09:11:10.856",
            "protection_type": "replication-pair",
            "replication_model": null
        }
    }

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

    网关超时。