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

修改数据库复制集名称

接口说明

修改数据库复制集名称。

文档数据库实例在修改数据库复制集名称过程中将不可用,请谨慎操作。

约束说明

  • 仅支持副本集实例。
  • 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时,不允许执行该操作。

URI

  • URI格式

    PUT 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,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

请求消息

  • 参数说明
    表2 请求Body参数

    参数

    是否必选

    参数类型

    描述

    name

    String

    连接地址复制集名称:

    实例高可用连接地址的唯一标识。该参数可以将读请求发送到副本集实例的所有节点。副本集中的所有主机必须具有相同的集名称。

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

请求示例

修改数据库复制集名称为replica
{ 
   "name" : "replica" 
 }

响应消息

  • 参数说明

    状态码:202

    表3 响应Body参数

    参数

    参数类型

    说明

    job_id

    String

    工作流 id。

    状态码:406

    表4 响应Body参数

    参数

    参数类型

    说明

    ErrorResponse

    Array of 表5 objects

    实例不是副本集或实例状态非“normal”,当前实例不允许此操作。

    表5 ErrorResponse

    参数

    参数类型

    说明

    error_code

    String

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

    error_msg

    String

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

  • 响应示例
    状态码:202
    { 
        "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" 
    }

状态码

详情请参见状态码

错误码

详情请参见错误码