You need to enable JavaScript to run this app.
导航
DescribeIpAddressPoolAttributes
最近更新时间:2024.09.06 10:16:24首次发布时间:2024.09.06 10:16:24

调用 DescribeIpAddressPoolAttributes 接口,查看指定IP地址池的详细信息。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeIpAddressPoolAttributes要执行的操作,取值:DescribeIpAddressPoolAttributes
VersionString2020-04-01API的版本信息,当前版本为2020-04-01。

IpAddressPoolId

String

ippool-fda83op****

IP 地址池的 ID。
您可以调用 DescribeIpAddressPools 接口,查询IP地址池的ID。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
IpAddressPoolIdStringippool-fda83op****IP地址池的ID。

BusinessStatus

String

Normal

IP地址池是否被锁定。

  • Normal: 正常。
  • FinancialLocked: 被锁定。

ISP

String

BGP

线路类型,取值如下:

  • BGP:BGP(多线)。
  • ChinaMobile:中国移动静态单线。
  • ChinaTelecom:中国电信静态单线。
  • ChinaUnicom:中国联通静态单线。
  • SingleLine_BGP:BGP单线。
  • Fusion_BGP:融合BGP。
  • ChinaMobile_Value:中国移动惠选型静态单线。
  • ChinaUnicom_Value:中国联通惠选型静态单线。
  • ChinaTelecom_Value:中国电信惠选型静态单线。
NameStringIpAddressPool01IP地址池的名称。
DescriptionStringThis is an IpAddressPoolIP地址池的描述信息。
CidrBlocksArray of struct["101.x.x.x/24"]IP地址池中的IP网段信息。
CreationTimeString2024-04-29 01:00:00IP地址池的创建时间。
UpdateTimeString2024-04-29 01:00:00IP地址池的更新时间。
DeletedTimeString2024-04-30 01:00:00资源回收时间。仅当资源欠费关停时,此参数才有返回值。
OverdueTimeString2024-04-30 01:00:00资源冻结时间。仅当资源欠费冻结时,此参数才会有返回值。
ProjectNameStringProject_1IP地址池所属项目的名称。
TagsArray of struct-IP地址池的标签信息。具体请参见下表“Tags”。

Status

String

Available

IP地址池的状态。

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
  • Pending:配置中。
TotalIpCountInteger256IP地址池中包含的IP地址段总数。
UsedIpCountInteger0IP地址池中已分配为EIP的IP地址段数量。

Tags

参数名称
类型
示例值
描述
KeyStringk1标签键。
ValueStringv1标签值。

请求示例

GET /?Action=DescribeIpAddressPoolAttributes&Version=2020-04-01&IpAddressPoolId=ippool-fda83op**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210624153033015207C4****",
        "Action": "DescribeIpAddressPoolAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{     
        "RequestId": "2021062415303301022514515207C4****",
        "IpAddressPoolId": "ippool-fda83op****",
        "BusinessStatus":"Normal",
        "ISP": "BGP",
        "Name": "IpAddressPool01",
        "Description": "This is an IpAddressPool",
        "CidrBlocks": [
            "101.0.XX.XX/24"
        ]
        "ProjectName": "Project_1",
        "Tags":[
            {
                "Key":"k1",
                "Value":"v1"
            }
        ]
        "Status": "Available", 
        "BusinessStatus": "Normal", 
        "TotalIpCount":256,
        "UsedIpCoun":0,
        "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
错误码
错误信息
描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。
404InvalidIPPool.NotFoundThe specified IP address pool does not exist.指定的IP地址池不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。