Docs

PrivateLink

Service allowlist

AddPermissionToVpcEndpointService - Adding an allowlist account to endpoint service

Call the AddPermissionToVpcEndpointService API to add a allowlist account to the specified endpoint service.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Action String required Example: AddPermissionToVpcEndpointService

Action to execute. Set the value to AddPermissionToVpcEndpointService.

Version String required Example: 2020-04-01

API version. The current version is 2020-04-01.

ServiceId String required Example: epsvc-2fe630gurkl37k5gfuy33****

ID of the endpoint service.

You can call the DescribeVpcEndpointServices API to get the ID of the endpoint service.

PermitAccountId String required Example: 2100000000

The ID of the account to be added to the allowlist.

You can call the DescribeVpcEndpoints API to query the account ID of the endpoint owner.

Response parameters

RequestId String optional Example: 0ED8D006-F706-4D23-88ED-E11ED28D****

Request ID.

Request examples

GET /?Action=AddPermissionToVpcEndpointService&Version=2020-04-01&ServiceId=epsvc-2fe630gurkl37k5gfuy33****&PermitAccountId=2100000000 HTTP/1.1​
Host: privatelink.cn-guangzhou.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-guangzhou/privatelink/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "AddPermissionToVpcEndpointService",​
        "Version": "2020-04-01",​
        "Service": "privatelink",​
        "Region": "cn-guangzhou"​
    },​
    "Result": {​
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****"​
    }​
}​

Error codes

This section displays only the error codes of the current API. For more error codes, see Common error codes.

Status code	Error codes	Error message	Explain
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	This request does not contain required parameters. Ensure that your request includes all required parameters, such as XXX. tip Here, XXX represents the name of the missing parameter.
400	InvalidPermitAccountId.Malformed	The specified PermitAccountId is malformed.	The specified PermitAccountId parameter format is invalid.
400	InvalidEndpointService.InvalidStatus	The specified EndpointService is not in the correct status for the request.	The specified endpoint is in a status that cannot respond to this request.
400	InvalidPermissionAccount.Conflict	The specified permission account already exists.	The specified allowlist account already exists.
404	InvalidEndpointService.NotFound	The specified EndpointService does not exist.	The specified endpoint service does not exist.

Last updated: 2026.03.06 14:17:02