查询用户在当前地域支持可用区列表和资源列表
最近更新时间: 2026-10-10 00:12:43
1. 接口描述
接口请求域名: clb.api3.fincloud.tencent.com。
查询用户在当前地域支持可用区列表和资源列表。
默认接口请求频率限制:20次/秒。
接口更新时间:2025-11-19 19:38:06。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeResources |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 是 | Uint64 | 返回可用区资源列表数目,默认20,最大值100。 示例值: 20 |
| Offset | 否 | 是 | Uint64 | 返回可用区资源列表起始偏移量,默认0。 示例值: 0 |
| Filters | 否 | 是 | Array of Filter | 查询可用区资源列表条件,详细的过滤条件如下: - master-zone 按照【地域可用区】进行过滤,例如:region1-2。 类型:String 必选:否 - ip-version 按照【IP 类型】进行过滤,例如:IPv4。 类型:String 必选:否 可选项:IPv4、IPv6、IPv6_Nat - isp 按照【ISP 类型】进行过滤,例如:BGP。 类型:String 必选:否 可选项:BGP、CMCC、CUCC、CTCC、BGP_PRO、INTERNAL 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ZoneResourceSet | Array of ZoneResource | 可用区支持的资源列表。 示例值:查看 |
| TotalCount | Uint64 | 可用区资源列表数目。 示例值: 3 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误 |
| InternalError | 内部错误 |
| FailedOperation | 操作失败 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| InvalidParameterValue.Duplicate | 参数值有重复。 |
| InvalidParameterValue.Range | 参数取值范围错误。 |
| InvalidParameterValue.InvalidFilter | Filter参数输入错误。 |
5. 示例
示例1 查询用户在当前地域支持可用区列表和资源列表
输入示例
https://clb.api3.fincloud.tencent.com/?Action=DescribeResources
&Offset=0
&Limit=20
&<Common Parameters>
输出示例
{
"Response": {
"TotalCount": 3,
"ZoneResourceSet": [
{
"Zone": "ap-region1-1",
"ResourceSet": [
{"Isp": "BGP", "Type": ["BGP"]},
{"Isp": "CMCC", "Type": ["CMCC"]}
]
}
],
"RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
}
}