更新时间:2025-05-29 GMT+08:00
分享

查询数据库复制集名称

接口说明

查询数据库复制集名称。

约束说明

仅支持副本集实例。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/replica-set/name

  • URI样例
    https://dds.cn-north-1.myhuaweicloud.com/v3/0d248ca90800d3902f79c014f11df3b8/instances/593416e7c9da4a4c97c6ad5b086b8ddfin02/replica-set/name
    表1 请求参数

    参数

    是否必选

    参数类型

    描述

    X-Auth-Token

    String

    参数解释:

    从IAM服务获取的用户Token。请参考认证鉴权

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    project_id

    String

    参数解释:

    租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    String

    参数解释:

    实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

无。

响应消息

  • 参数说明

    状态码:200

    表2 响应Body参数

    参数

    参数类型

    说明

    name

    String

    参数解释:

    连接地址复制集名称:实例高可用连接地址的唯一标识。

    该参数可以将读请求发送到副本集实例的所有节点。副本集中的所有主机必须具有相同的集名称。

    取值范围:

    字符限制:在3位到128位之间,必须以英文字母开头,区分大小写,可以包含字母、数字、中划线或下划线,不能包含其他特殊字符。

    状态码:406

    表3 响应Body参数

    参数

    参数类型

    说明

    ErrorResponse

    Array of 表4 objects

    参数解释:

    实例不是副本集,当前实例不允许此操作。

    取值范围:

    不涉及。

    表4 ErrorResponse

    参数

    参数类型

    说明

    error_code

    String

    参数解释:

    提交任务异常时返回的错误编码。

    取值范围:

    不涉及。

    error_msg

    String

    参数解释:

    提交任务异常时返回的错误描述信息。

    取值范围:

    不涉及。

  • 响应示例
    状态码:200
    { 
        "name" : "replica" 
    }

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档

    OSZAR »