调用 DescribeIpAddressPools 接口，按条件查询已创建的IP地址池的详细信息。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeIpAddressPools | 要执行的操作，取值：DescribeIpAddressPools。 |
| Version | String | 是 | 2020-04-01 | API的版本信息，当前版本为2020-04-01。 |
| IpAddressPoolIds.N | String | 否 | ippool-fda83op**** | IP地址池的ID。 |
ISP | String | 否 | BGP | 线路类型，默认为BGP。
|
Name | String | 否 | IpAddressPool01 | IP地址池的名称，暂不支持模糊查询。
|
Status | String | 否 | Available | IP地址池的状态。取值如下：
|
| ProjectName | String | 否 | Project_1 | IP地址池所属项目的名称。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3 | 标签的标签键。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1 | 标签的标签值。
说明
|
| PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 |
| PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100，默认值为20。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证，用于标记分页的位置。
|
| MaxResults | Integer | 否 | 50 | 查询的数量，最大值为100，默认值为10。 |
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 20210624153033015207C4**** | 请求ID。 |
| TotalCount | Integer | 1 | 符合条件的IP地址池网段总数。 |
| PageNumber | Integer | 1 | 当前页码。 |
| PageSize | Integer | 10 | 当前分页的行数。 |
| NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。 |
| IpAddressPooCidrBlocks | Array of Struct | - | IP地址池的网段信息。具体请参见下表“IpAddressPool结构”。 |
IpAddressPool
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| IpAddressPoolId | String | ippool-fda83op**** | IP地址池的ID。 |
BusinessStatus | String | Normal | IP地址池是否被锁定。
|
ISP | String | BGP | 线路类型，取值如下：
|
Status | String | Available | IP地址池的状态。
|
| Name | String | IpAddressPool01 | IP地址池的名称。 |
| Description | String | This is an IpAddressPool | IP地址池的描述信息。 |
| TotalIpCount | Integer | 256 | IP地址池中包含的IP地址段总数。 |
| UsedIpCount | Integer | 0 | IP地址池中已分配为EIP的IP地址段数量。 |
| CidrBlocks | Array of String | ["101.x.x.x/24"] | IP地址池网段。 |
| ProjectName | String | Project_1 | IP地址池所属项目的名称。 |
| Tags | Array of struct | - | IP地址池的标签信息。具体请参见下表“Tags结构”。 |
| CreationTime | String | 2024-04-29 01:00:00 | IP地址池的创建时间。 |
| UpdateTime | String | 2024-04-29 01:00:00 | IP地址池的更新时间。 |
| DeletedTime | String | 2024-04-30 01:00:00 | 资源回收时间。仅当资源欠费关停时，此参数才有返回值。 |
| OverdueTime | String | 2024-04-30 01:00:00 | 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。 |
Tags
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | k1 | 标签键。 |
| Value | String | v1 | 标签值。 |
GET /?Action=DescribeIpAddressPools&Version=2020-04-01&IpAddressPoolId=ippool-fda83op**** HTTP/1.1 Host: open.volcengineapi.com Service: vpc Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "20210624153033015207C4****", "Action": "DescribeIpAddressPools", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result":{ "RequestId": "2021062415303301022514515207C4****", "TotalCount":1, "PageNumber":1, "PageSize":10, "NextToken":"caeba0bbb2be03f84eb48b699f0a****", "IpAddressPooCidrBlocks":[ { "IpAddressPoolId": "ippool-fda83op****", "BusinessStatus":"Normal", "ISP": "BGP", "Status": "Available", "Name": "IpAddressPool01", "Description": "This is an IpAddressPool", "TotalIpCount":256, "UsedIpCount":0, "CidrBlocks": [ "101.0.XX.XX/24" ] "ProjectName": "Project_1", "Tags":[ { "Key":"k1", "Value":"v1" } ] "CreationTime": "2024-04-29 01:00:00", "UpdateTime": "2024-04-29 01:00:00", "OverdueTime": "2024-04-30 01:00:00", "DeletedTime": "2024-04-30 01:00:00" } ] } }
公共错误码，请参见 公共错误码 。
HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | Arguments on this idempotent request are inconsistent with arguments used in previous request(s). | 此幂等请求的参数与前一个请求中使用的参数不一致。 |
| InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 | |
| InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 | |
| InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 | |
| InvalidParameter | A parameter specified in the request is not valid, is unsupported or cannot be used. | 该请求传入了非法或不支持的参数。 | |
| InvalidParameter.ClientTokenMalformed | The specified parameter ClientToken is malformed. | 指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。 | |
| InvalidTagFilter.Disorder | The specified index order of tag filter is malformed. | 指定标签过滤项的索引顺序参数格式不合法。 | |
| InvalidTagFilterKey.Malformed | The specified parameter tag filter key is invalid. | 过滤标签键不合法。 | |
| InvalidTagFilterValue.Malformed | The specified parameter tag filter value is invalid. | 过滤标签值不合法。 | |
| LimitExceeded.Resource | You've reached the limit on the number of resources that you can operate at one time. | 已达到单次可操作资源数量的上限。 | |
| LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 | |
| LimitExceeded.TagFilterValue | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签值数量的上限。 | |
| 412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 幂等请求处理中。 |