ListVpcEndpointServiceUsers - PrivateLink - Alibaba Cloud Documentation Center

Queries the whitelist of an endpoint 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

privatelink:ListVpcEndpointServiceUsers

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service that you want to query. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is your first request and no next requests are to be performed, you do not need to specify this parameter. If a next request is to be performed, set the value to the value of NextToken that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.	50
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
UserId	integer	No	The ID of the Alibaba Cloud account in the whitelist of the endpoint service.	12345678
RegionId	string	Yes	The region ID of the endpoint service that you want to query. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
UserListType	string	No	The type of the user list in the whitelist of the endpoint service.	Users

Response elements

Element	Type	Description	Example
	object
NextToken	string	The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values: If no value is returned for NextToken, no next requests are performed. If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries returned on each page.	50
Users	array<object>	The Alibaba Cloud accounts in the whitelist of the endpoint service.
	object
UserId	integer	The ID of the Alibaba Cloud account in the whitelist of the endpoint service.	12345678
UserARNs	array<object>	The whitelists in the format of Aliyun Resource Name (ARN).
	object
UserARN	string	The whitelist in the format of ARN.	acs:ram:::
TotalCount	string	The total number of entries returned.	3

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "Users": [
    {
      "UserId": 12345678
    }
  ],
  "UserARNs": [
    {
      "UserARN": "acs:ram:*::*"
    }
  ],
  "TotalCount": "3"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.