ListIpams - 查询IPAM实例_专有网络VPC(VPC)-阿里云帮助中心

查询ipam。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListIpams	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
ResourceGroupId	string	否	IPAM 的资源组 ID。	rg-aek2sermdd6****
IpamIds	array	否	IPAM 的实例 ID 列表。N 的取值范围为 1~100，即一次最多查询 100 个 IPAM 实例。
IpamId	string	否	IPAM 的实例 ID。	ipam-ccxbnsbhew0d6t****
IpamName	string	否	IPAM 的名称。长度为 1～128 个字符，不能以`http://`或`https://`开头。	test
Tags	array<object>	否	标签列表信息。
Tag	object	否	标签列表信息。
Key	string	否	标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持 128 个字符，不能包含`http://`或者`https://`。	FinanceJoshua
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	long	否	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	10

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
Ipams	array<object>	IPAM 实例列表。
Ipam	object	IPAM 实例列表。
IpamId	string	IPAM 的实例 ID。	ipam-ccxbnsbhew0d6t****
IpamName	string	IPAM 的名称。	test
IpamDescription	string	IPAM 的描述信息。	test description
OperatingRegionList	array	IPAM 的生效地域列表。
OperatingRegionList	string	IPAM 生效地域。	cn-hangzhou
PrivateDefaultScopeId	string	创建 IPAM 后，系统默认创建的私网 IPAM 作用范围。	ipam-scope-okoerbco6unqfr****
PublicDefaultScopeId	string	创建 IPAM 后，系统默认创建的公网 IPAM 作用范围。	ipam-scope-ovb76p1g1m19dr****
ScopeCount	integer	IPAM 作用范围的个数。取值范围：2~5。	2
IpamStatus	string	IPAM 实例的状态。取值： Creating：表示创建中。 Created：表示创建完成。 Deleting：表示删除中。 Deleted：表示已删除。	Created
ResourceGroupId	string	IPAM 的资源组 ID。	rg-aek2dbprgpt****
CreateTime	string	IPAM 创建的时间。	2022-07-01T02:05:23Z
Tags	array<object>	标签列表。
Tag	object	标签列表。
Key	string	标签键	FinanceDept
Value	string	标签值。	FinanceJoshua
RegionId	string	查询到的 IPAM 实例的地域 ID。	cn-hangzhou
OwnerId	long	IPAM 实例资源拥有者的阿里云主账号。	1210123456******
DefaultResourceDiscoveryId	string	默认资源发现实例 ID。	ipam-res-disco-jt5f2af2u6nk2z321****
DefaultResourceDiscoveryAssociationId	string	默认的资源发现关联关系 ID。	ipam-res-disco-assoc-jt5fac8twugdbbgip****
ResourceDiscoveryAssociationCount	integer	资源发现数量。	1
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	long	列表条目数。	10
MaxResults	long	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	20
Count	long	分批次查询时返回的具体条目数。	10
RequestId	string	请求 ID。	23CA0A0B-B0F5-5495-B355-7D9A9203A46B

示例

正常返回示例

JSON格式

{
  "Ipams": [
    {
      "IpamId": "ipam-ccxbnsbhew0d6t****",
      "IpamName": "test",
      "IpamDescription": "test description",
      "OperatingRegionList": [
        "cn-hangzhou"
      ],
      "PrivateDefaultScopeId": "ipam-scope-okoerbco6unqfr****",
      "PublicDefaultScopeId": "ipam-scope-ovb76p1g1m19dr****",
      "ScopeCount": 2,
      "IpamStatus": "Created",
      "ResourceGroupId": "rg-aek2dbprgpt****",
      "CreateTime": "2022-07-01T02:05:23Z",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "RegionId": "cn-hangzhou",
      "OwnerId": 0,
      "DefaultResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
      "DefaultResourceDiscoveryAssociationId": "ipam-res-disco-assoc-jt5fac8twugdbbgip****",
      "ResourceDiscoveryAssociationCount": 1
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "MaxResults": 20,
  "Count": 10,
  "RequestId": "23CA0A0B-B0F5-5495-B355-7D9A9203A46B"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-12	OpenAPI 返回结构发生变更	查看变更详情
2024-08-28	OpenAPI 返回结构发生变更	查看变更详情