Adds account IDs to the whitelist of an endpoint service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddUserToVpcEndpointService

The operation that you want to perform. Set the value to AddUserToVpcEndpointService.

RegionId String Yes eu-west-1

The ID of the region where the endpoint service is deployed. You can call the DescribeRegions operation to query region IDs.

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

UserId Long Yes 12345678

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

DryRun Boolean No false

Specifies whether to only check the API request. Valid values:

true: only checks the API request. If you select this option, the account ID is not added to the whitelist of the endpoint service after the request passes the check. Check items include whether the AccessKey pair is valid, whether the RAM user is authorized, and whether the required parameters are specified. If the request fails to meet the requirements in the check items, an error message is returned. If the request meets the requirements in the check items, the DryRunOperation error code is returned.

false (default): checks the API request. After the request passes the check, the 2XX HTTP status code is returned, and the account ID is added to the whitelist of the endpoint service.

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

The client token that is used to ensure the idempotence of the request. You can use the client to generate a value that is unique among different requests. ClientToken can contain only ASCII characters. It must be 1 to 64 characters in length.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=AddUserToVpcEndpointService
&RegionId=eu-west-1
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&UserId=12345678
&<Common request parameters>

Sample success responses

XML format

<AddUserToVpcEndpointServiceResponse>  
       <RequestId>3109D437-5D6D-4A28-B5F5-EF936DExxxx</RequestId>
</AddUserToVpcEndpointServiceResponse>

JSON format

{
	"RequestId": "3109D437-5D6D-4A28-B5F5-EF936DExxxx"
}

Error codes

HttpCode Error code Error message Description
400 EndpointServiceNotFound The specified Service does not exist. The error message returned because the specified endpoint service does not exist.

For a list of error codes, visit the API Error Center.