ListIpams - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries one or more IPAMs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ListIpams

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region of the IPAM. You can call DescribeRegions to get the region ID.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the IPAM belongs.	rg-aek2sermdd6****
IpamIds	array	No	The IDs of the IPAMs. You can specify up to 100 IPAM IDs.
	string	No	The ID of the IPAM.	ipam-ccxbnsbhew0d6t****
IpamName	string	No	The name of the IPAM. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test
Tags	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. It must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request or when no next page exists. If a next page exists, set the value to the NextToken value returned in the last API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The information returned.
Ipams	array<object>	A list of IPAM instances.
	object	A list of IPAM instances.
IpamId	string	The ID of the IPAM.	ipam-ccxbnsbhew0d6t****
IpamName	string	The name of the IPAM.	test
IpamDescription	string	The description of the IPAM.	test description
OperatingRegionList	array	The list of operating regions of the IPAM.
	string	The operating region of the IPAM.	cn-hangzhou
PrivateDefaultScopeId	string	The ID of the default private scope that is automatically created when you create the IPAM.	ipam-scope-okoerbco6unqfr****
PublicDefaultScopeId	string	The ID of the default public scope that is automatically created when you create the IPAM.	ipam-scope-ovb76p1g1m19dr****
ScopeCount	integer	The number of scopes in the IPAM. Valid values: 2 to 5.	2
IpamStatus	string	The status of the IPAM. Valid values: Creating: The IPAM is being created. Created: The IPAM is created. Deleting: The IPAM is being deleted. Deleted: The IPAM is deleted.	Created
ResourceGroupId	string	The ID of the resource group to which the IPAM belongs.	rg-aek2dbprgpt****
CreateTime	string	The time when the IPAM was created.	2022-07-01T02:05:23Z
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
RegionId	string	The ID of the region where the IPAM is created.	cn-hangzhou
OwnerId	integer	The ID of the Alibaba Cloud account to which the IPAM belongs.	1210123456******
DefaultResourceDiscoveryId	string	The ID of the default resource discovery.	ipam-res-disco-jt5f2af2u6nk2z321****
DefaultResourceDiscoveryAssociationId	string	The ID of the default resource discovery association.	ipam-res-disco-assoc-jt5fac8twugdbbgip****
ResourceDiscoveryAssociationCount	integer	The number of resource discovery associations.	1
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries.	10
MaxResults	integer	The maximum number of entries returned per page. Valid values: 1 to 100. Default value: 10.	20
Count	integer	The number of entries returned on the current page.	10
RequestId	string	The request ID.	23CA0A0B-B0F5-5495-B355-7D9A9203A46B

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.