查询可用IP地址列表
1. 接口描述
调用 DescribeAvailableIps 接口查询指定IP地址网段的可用IP列表。
2. 请求参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 固定取值:DescribeAvailableIps |
RegionCode | String | 是 | 地域编码,您可以调用 DescribeRegionConfig 接口获取地域编码 |
BandwidthType | String | 是 | 线路类型 |
CidrBlock | String | 是 | IP地址网段 |
2. 返回数据
名称 | 类型 | 说明 |
---|---|---|
Data | List< String > | 可用IP地址列表集合 |
RequestId | String | 请求ID |
4. 示例
请求示例
http://ecs.kpy.cloud/?AccessKeyId=pm00003fm05q
&Action=DescribeAvailableIps
&BandwidthType=BGP
&CidrBlock=16.23.13.192%2F26
&Format=JSON
&RegionCode=cn-dev-1
&SignatureMethod=HMAC-SHA1
&SignatureNonce=319f90eb-09d9-41c0-9709-2023a432469f
&SignatureVersion=1.0
&Timestamp=2023-12-11T10%3A21%3A29Z
&Version=2014-05-26
&Signature=8ynBCgQAzh1tKZAIC%2FpCt2UWkac%3Daaaa
正常返回示例
{
"RequestId": "10074f70-980f-11ee-8ae2-6257c1bc0ccd",
"Data": [
"16.23.13.195",
"16.23.13.196",
"16.23.13.197",
"16.23.13.198",
"16.23.13.199",
"16.23.13.200",
"16.23.13.201",
"16.23.13.202",
"16.23.13.203",
"16.23.13.204"
]
}
5. 错误码
错误码 | 错误信息 |
---|---|
MissingParameter | RegionCode 参数不能为空 |
MissingParameter | BandwidthType 参数不能为空 |
MissingParameter | CidrBlock 参数不能为空 |
AvailableRegionNotFound | 可用的地域未找到 |
DescribeAvailableIpsFail | 查询可用IP地址列表失败:xxx |