ListIpamMembers - Virtual Private Cloud - Alibaba Cloud Documentation Center

Lists the members managed by the IPAM trusted service.

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

list

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region of the IPAM. Call the DescribeRegions operation to get the region ID.	cn-hangzhou
MemberIds	array	No	A list of IDs of members managed by the IPAM trusted service.
	string	No	The ID of a member managed by the IPAM trusted service.	fd-ccccncASqa
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: If NextToken is empty, no more results are available. If NextToken has a value, the value is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	20

Response elements

Element	Type	Description	Example
	object	ListTokenResult
MemberInfos	array<object>	A list of members managed by the IPAM trusted service.
	object
CreationTime	string	The time when the member was added.	2025-07-11T07:18:07Z
MemberId	string	The member ID. Folder ID: The ID of the folder. Account UID: The UID of the member account in the resource directory.	fd-ccccncASqa
MemberType	string	The type of the member. Valid values: Folder: The member is a folder. Account: The member is a member account in the resource directory.	Folder
Status	string	The status of the member managed by the IPAM trusted service. Valid values: Created: The member is managed. Deleted: The member is removed.	Created
NextToken	string	The token that is used to retrieve the next page of results. Valid values: If NextToken is empty, no more results are available. If NextToken has a value, the value is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that match the query.	20
MaxResults	integer	The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned on the current page.	6
RequestId	string	The request ID.	B90776C8-F703-51D5-893A-AD1CA699D535

Examples

Success response

JSON format

{
  "MemberInfos": [
    {
      "CreationTime": "2025-07-11T07:18:07Z",
      "MemberId": "fd-ccccncASqa",
      "MemberType": "Folder",
      "Status": "Created"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 20,
  "MaxResults": 10,
  "Count": 6,
  "RequestId": "B90776C8-F703-51D5-893A-AD1CA699D535"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.IpamNotExist	The operation is not allowed because the IPAM does not exist.	IPAM does not exist in the current region. IPAM trusted service members cannot be managed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.