DescribeZones--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeZones

最近更新时间：2024.06.04 17:37:56首次发布时间：2022.11.11 09:44:55

调用DescribeZones接口，查询当前地域的主备可用区映射关系。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeZones	要执行的操作，取值为DescribeZones。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID。
MasterZones	Array of Struct	-	主可用区列表。具体请参见下表“ MasterZones ”。

MasterZones

名称	类型	示例值	描述
ZoneId	String	cn-shanghai-a	主可用区ID。当前地域为单可用区部署时，该参数返回CLB实例部署的可用区ID。
SlaveZones	Array of String	-	该主可用区对应的备可用区列表。具体请参见下表“ SlaveZones ”。

SlaveZones

名称	类型	示例值	描述
ZoneId	String	cn-shanghai-b	备可用区ID。当前地域为单可用区部署时，该参数返回为空。

请求示例

GET /?Action=DescribeZones&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-shanghai
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeZones",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-shanghai"
    },   
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "MasterZones": [
            {
                "ZoneId": "cn-shanghai-a",
                "SlaveZones": [
                       "ZoneId": "cn-shanghai-b"
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。说明其中，XXX表示缺少的参数名称。
404	InvalidZone.NotFound	The specified Zone mapping does not exist.	指定主备可用区关系不存在。