Use AddUserToVpcEndpointService to add a user to an endpoint service whitelist - PrivateLink - Alibaba Cloud - PrivateLink

Operation description

Before adding a service whitelist entry, make sure the endpoint service is in the Active state. You can call the GetVpcEndpointServiceAttribute operation to query the endpoint service status.
The AddUserToVpcEndpointService operation does not support concurrent requests to add service whitelist entries under the same Alibaba Cloud account.

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

create

*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 for which you want to add a service whitelist entry. You can call the DescribeRegions operation to query the most recent region list.	eu-west-1
UserId	integer	No	The ID of the user account to add to the service whitelist.	132193271328****
ServiceId	string	Yes	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without adding the service whitelist entry. The system checks the required parameters, request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	Yes	The user whitelist entry in ARN format.	acs:ram:::
UserARN	string	No	The whitelist in the format of Aliyun Resource Name (ARN).	acs:ram:::

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	MissingParam.UserArn	The param of UserArn is missing.
400	Mismatch.UserIdAndUserArn	The %s and %s are mismatched.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.