All Products
Search
Document Center

PrivateLink:AddUserToVpcEndpointService

Last Updated:Feb 18, 2024

Adds an account ID to the whitelist of an endpoint service.

Operation description

  • Before you add an account ID to the whitelist of an endpoint service, make sure that the endpoint service is in the Active state. You can call the GetVpcEndpointServiceAttribute operation to query the status of the endpoint service.
  • You cannot repeatedly call the AddUserToVpcEndpointService operation to add the ID of an Alibaba Cloud account to the whitelist of an endpoint service within a specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:AddUserToVpcEndpointServiceWrite
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the endpoint service. You can call the DescribeRegions operation to query the most recent region list.

eu-west-1
UserIdlongNo

The account ID that you want to add to the whitelist.

132193271328****
ServiceIdstringYes

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect 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 performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
ClientTokenstringNo

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
UserARNstringNo

The whitelist in the format of Aliyun Resource Name (ARN).

acs:ram:*:<account-id>:*

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.
400MissingParam.UserArnThe param of UserArn is missing.-
400Mismatch.UserIdAndUserArnThe %s and %s are mismatched.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-31The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2022-09-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2022-06-25The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: UserARN