文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V1/ 其他接口/ 查询可用区信息
更新时间：2024-01-30 GMT+08:00
查看PDF
分享

查询可用区信息

当前页面API为历史版本API，未来可能停止维护。请使用查询可用区信息。

功能介绍

在创建实例时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。

URI

GET /v1.0/availableZones

请求消息

请求参数

无。

请求示例

GET https://{dms_endpoint}/v1.0/availableZones

响应消息

响应参数

参数说明见表1、表2。

表1 参数说明

参数

类型

说明

region_id

String

区域ID。

available_zones

Array

可用区数组，具体请参考表2。
表2 available_zones参数说明

参数

类型

说明

soldOut

Boolean

是否售罄。

id

String

可用区ID。

code

String

可用区编码。

name

String

可用区名称。

port

String

可用区端口号。

resource_availability

String

分区上是否还有可用资源。

  • true：还有资源。
  • false：资源已售罄。

响应示例

{  
    regionId: "XXXX",  
    available_zones:[  
       {  
            "id":"1d7b939b382c4c3bb3481a8ca10da768",  
            "name":"az10.dc1",  
            "code":"az10.dc1",  
            "port":"8002", 
            "resource_availability": "true" 
        },    
        {  
            "id":"1d7b939b382c4c3bb3481a8ca10da769",  
            "name":"az10.dc2",  
            "code":"az10.dc2",  
            "port":"8002", 
            "resource_availability": "true" 
        }  
    ]  
}

状态码

操作成功的状态码如表3所示，其他响应见状态码。

表3 状态码

状态码

描述

200

查询成功。
父主题： 其他接口

相关文档