更新时间:2022-04-12 GMT+08:00
分享

打开集群的Shard/Config IP开关

功能介绍

打开集群的Shard/Config IP开关。

接口约束

  • 冻结实例不支持该操作。
  • 针对IPV6子网创建的实例不支持该操作。
  • 针对已打开IP开关的组, 在开关打开之后需要用户手动重启对应组才能生效。
  • 支持版本为3.4和4.0的社区版集群实例。
  • 该功能打开后暂不支持关闭。

调试

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

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/create-ip

  • 参数说明
    表1 参数说明

    名称

    是否必选

    描述

    project_id

    租户在某一region下的project ID。

    instance_id

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

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    描述

    type

    String

    待打开IP开关的对象类型。

    • 对于shard组时,取值为“shard”。
    • 对于config组时,取值为“config”。

    target_id

    String

    待打开IP开关的组ID。

    • 对于shard组,取值为shard组ID。
    • 对于config组,取值为config组ID。
    • 如果为空,则打开该实例下同group类型的所有开关。
    注意:
    • 第一次打开实例开关, 该参数需要传空。
    • 针对已开启开关的组, 开关不允许重复下发。

    password

    String

    打开集群开关设置的密码。

    • 取值范围:长度为8~32位,必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_=+?的组合。
    • 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。
    注意:

    该密码暂不支持修改,请谨慎操作。

  • 请求体样例
    {
        "type": "shard",
        "target_id": "91bac9f23ead42e19013333e05f44829gr02",
        "password": "******"
    }

响应消息

  • 响应样例
    {}
    

状态码

详情请参见状态码

错误码

详情请参见错误码

分享:

    相关文档

    相关产品

close