GetIpamPoolAllocation - 查询指定IPAM地址池CIDR分配的信息

查询指定IPAM地址池CIDR分配的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:GetIpamPoolAllocationget
*IpamPool
acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}

请求参数

名称类型必填描述示例值
RegionIdstring

IPAM 地址池 CIDR 分配所属 IPAM Pool 的所在地域。

说明 当 IPAM 地址池 CIDR 分配所属 IPAM Pool 具备地域属性时,该属性为 IPAM Pool 的所在地域。当 IPAM 地址池 CIDR 分配所属 IPAM Pool 不具备地域属性时,该属性为 IPAM 托管地域。
cn-hangzhou
IpamPoolAllocationIdstring

IPAM 地址池 CIDR 分配的实例 ID。

ipam-pool-alloc-112za33e4****

返回参数

名称类型描述示例值
object

PlainResult

RequestIdstring

请求 ID。

3748DEFF-68BE-5EED-9937-7C1D0C21BAB4
IpamPoolAllocationIdstring

IPAM 地址池 CIDR 分配的实例 ID。

ipam-pool-alloc-112za33e4****
Cidrstring

分配的地址段。

192.168.1.0/24
SourceCidrstring

源地址段。

192.168.0.0/16
ResourceIdstring

分配给的资源 ID。

vpc-bp16qjewdsunr41m1****
ResourceTypestring

分配给的资源类型。取值:

  • VPC:表示资源的类型为 VPC。
  • IpamPool:表示资源的类型为子地址池。
  • Custom:表示资源的类型为自定义预留网段。
VPC
ResourceRegionIdstring

资源生效的地域 ID。

cn-hangzhou
ResourceOwnerIdlong

资源归属的阿里云账号(主账号)ID。

1616080591216318
RegionIdstring

IPAM 地址池 CIDR 分配所属 IPAM Pool 的所在地域。

说明 当 IPAM 地址池 CIDR 分配所属 IPAM Pool 具备地域属性时,该属性为 IPAM Pool 的所在地域。当 IPAM 地址池 CIDR 分配所属 IPAM Pool 不具备地域属性时,该属性为 IPAM 托管地域。
cn-hangzhou
IpamPoolIdstring

IPAM 地址池的实例 ID。

ipam-pool-6rcq3tobayc20t****
Statusstring

实例的状态。取值:

  • Created:表示创建完成。
  • Deleted:表示已删除。
Created
CreationTimestring

实例创建时间。

2024-10-15T10:24:19+08:00
IpamPoolAllocationDescriptionstring

IPAM 地址池 CIDR 分配的描述信息。

长度为 1~256 个字符,必须以大小写英文字母或中文字符开头,但不能以http://https://开头。不填则为空,默认值为空。

ipam pool allocation description
IpamPoolAllocationNamestring

IPAM 地址池 CIDR 分配的名称。

长度为 1~128 个字符,不能以http://https://开头。

ipam pool allocation name

示例

正常返回示例

JSON格式

{
  "RequestId": "3748DEFF-68BE-5EED-9937-7C1D0C21BAB4",
  "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
  "Cidr": "192.168.1.0/24",
  "SourceCidr": "192.168.0.0/16",
  "ResourceId": "vpc-bp16qjewdsunr41m1****",
  "ResourceType": "VPC",
  "ResourceRegionId": "cn-hangzhou",
  "ResourceOwnerId": 1616080591216318,
  "RegionId": "cn-hangzhou",
  "IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
  "Status": "Created",
  "CreationTime": "2024-10-15T10:24:19+08:00",
  "IpamPoolAllocationDescription": "ipam pool allocation description",
  "IpamPoolAllocationName": "ipam pool allocation name"
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.IpamPoolAllocationThe specified resource of IPAM pool allocation is not found.输入的IPAM地址池分配关系不存在。
400OperationDenied.IpamRegionNotSupportGetPoolAllocationThe operation is not allowed because IPAM region does not support getting the allocation.无法在IPAM地域执行查询指定地址池分配的操作。

访问错误中心查看更多错误码。