ListIpamScopes - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the details of IPAM scopes.

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:ListIpamScopes

list

*IpamScope

acs:vpc:{#regionId}:{#accountId}:ipamscope/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM instance is deployed. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
IpamId	string	No	The instance ID of the IPAM.	ipam-ccxbnsbhew0d6t****
IpamScopeType	string	No	The type of the IPAM scope. Valid values: public: the public scope. private: the private scope.	private
IpamScopeIds	array	No	The instance IDs of the IPAM scopes.
	string	No	The instance ID of an IPAM scope. You can specify up to 20 instance IDs.	ipam-scope-glfmcyldpm8lsy****
IpamScopeName	string	No	The name of the IPAM scope. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test
ResourceGroupId	string	No	The ID of the resource group to which the IPAM scope belongs.	rg-aek2sermdd6****
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. It can contain digits, periods (.), underscores (_), and hyphens (-). The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. 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. It cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	No	The token that is used for the next query. Valid values: You do not need to specify this parameter for the first query. For a subsequent query, set this parameter to the NextToken value returned from the last query.	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.
IpamScopes	array<object>	A list of IPAM scopes.
	object	A list of IPAM scopes.
CreateTime	string	The time when the IPAM scope was created.	2022-04-18T03:12:37Z
IpamScopeId	string	The instance ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
IpamScopeType	string	The type of the IPAM scope. Valid values: public: the public scope. private: the private scope.	private
Status	string	The status of the IPAM scope. Valid values: Creating: The IPAM scope is being created. Created: The IPAM scope is created. Deleting: The IPAM scope is being deleted. Deleted: The IPAM scope is deleted.	Created
IpamId	string	The instance ID of the IPAM.	ipam-ccxbnsbhew0d6t****
PoolCount	integer	The number of IPAM pools in the IPAM scope.	2
IpamScopeName	string	The name of the IPAM scope.	test
IpamScopeDescription	string	The description of the IPAM scope.	test description
ResourceGroupId	string	The ID of the resource group to which the IPAM scope belongs.	rg-acfmxazb4ph6aiy****
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceDept
IsDefault	boolean	Indicates whether the scope is the default scope. Valid values: true: The scope is the default scope. false: The scope is not the default scope.	true
RegionId	string	The region ID of the IPAM scope.	cn-hangzhou
OwnerId	integer	The ID of the Alibaba Cloud account to which the IPAM scope belongs.	1210123456******
NextToken	string	The token that is used for the next 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 returned.	1000
MaxResults	integer	The maximum number of entries returned per page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned on the current page.	10
RequestId	string	The request ID.	8859C501-97E7-53D4-B94B-2A9E16003B22

Examples

Success response

JSON format

{
  "IpamScopes": [
    {
      "CreateTime": "2022-04-18T03:12:37Z",
      "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****",
      "IpamScopeType": "private",
      "Status": "Created",
      "IpamId": "ipam-ccxbnsbhew0d6t****",
      "PoolCount": 2,
      "IpamScopeName": "test",
      "IpamScopeDescription": "test description",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceDept"
        }
      ],
      "IsDefault": true,
      "RegionId": "cn-hangzhou",
      "OwnerId": 0
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "8859C501-97E7-53D4-B94B-2A9E16003B22"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.