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

查询实例可迁移到的可用区

接口说明

查询实例可迁移到的可用区。

约束说明

  • 如需使用该接口,请联系相关工作人员申请开通。
  • 支持DDS社区版集群、副本集实例。
  • 跨AZ实例不支持该操作。
  • IPV6子网创建的实例不支持该操作。
  • 针对副本集实例,如果当前存在只读节点或未激活的备节点,不支持该操作。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrate/az

  • URI样例

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/migrate/az

请求消息

参数说明

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

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

project_id

string

path

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

instance_id

string

path

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

响应消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    az_list

    Array of objects

    可用区具体信息。详情请参见表3

    表3 az_list 字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    code

    String

    可用区ID。

    description

    String

    可用区描述。

    status

    String

    当前可用区的的状态。

    • ENABLED,表示该可用区(组合)可用。
    • DISABLED,表示该可用区(组合)不可用。
  • 响应示例
    {
        "az_list": [
            {
                "code": "az3xahz",
                "description": "可用区3",
                "status": "DISABLED"
                }
               {
                "code": "az1xahz,az2xahz,az3xahz",
                "description": "可用区1,可用区2,可用区3",
                "status": "ENABLED"
                }
         ]
    }

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码