PrivateLink
PrivateLink
Document
- Documentation
PrivateLinkAPI referenceGateway endpointCreateVpcGatewayEndpoint - Creating the gateway endpoint instance
Copy page
Download PDFGateway endpoint
CreateVpcGatewayEndpoint - Creating the gateway endpoint instance
Copy pageDownload PDFCreateVpcGatewayEndpoint - Creating the gateway endpoint instance
Call the CreateVpcGatewayEndpoint API to create a gateway endpoint.
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.
Request parameters
Action String required Example: CreateVpcGatewayEndpoint
Action to execute. Set the value to CreateVpcGatewayEndpoint.
Version String required Example: 2020-04-01
API version. The current version is 2020-04-01.
VpcId String required Example: vpc-bp15zkdt37pq72zv****
The ID of the VPC to which the gateway endpoint belongs.
ServiceId String required Example: gwepsvc-2fe630gurkl37k5gfuy33****
The ID of the gateway endpoint service to be associated.
You can call the DescribeVpcGatewayEndpointServices API to obtain the ID of the gateway endpoint service.
EndpointName String optional Example: endpoint-01
Name of the gateway endpoint.
- Must start with a letter, number, or Chinese character. May include letters, numbers, Chinese characters, and the following symbols: periods (.), underscores (_), and hyphens (-).
- Must be 1 to 128 characters.
- If left blank, it defaults to the ID of the gateway endpoint.
ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****
The Client Token that is used to ensure the request idempotency.
- This parameter value is auto-generated by the client. Ensure uniqueness across requests, preventing duplicate actions caused by multiple client retries during API timeouts or server internal errors.
- Must not exceed 64 ASCII characters.
- If you do not set this parameter, idempotency check is not performed.
Description String optional Example: GatewayEndpoint
The description of the gateway endpoint. The default value is an empty string.
- Must start with a letter, number, or Chinese character. May include letters, numbers, Chinese characters, and the following symbols: commas (,), periods (.), underscores (_), spaces ( ), equal signs (=), hyphens (-), full-width commas ( ， ), and full-width periods ( 。 ).
- The length limit is 0 to 255 characters.
ProjectName String optional Example: default
Name of the project to which the gateway endpoint belongs.
VpcPolicy String optional Example: { "Statement" : [ { "Effect": "Allow", "Principal": "*", "Action": "*", "Resource": "*"} ] }
Access policy for the gateway endpoint. If left blank, it defaults to default policy. The default policy allows the gateway endpoint to access all bucket resources of the Torch Object Storage (TOS).
For detailed descriptions of each field in the access policy, see Bucket policy parameter reference.
Tags.N.Key String optional Example value: k1
The tag key of the endpoint user tag.
- The length limit is 1 to 128 characters.
- Case-sensitive. Must not start with volc: or sys: in any case form.
- Must not start or end with a space.
- May include letters, numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), and at signs (@).
tip
Duplicate tag keys are not allowed for the same resource.
Tags.N.Value String optional Example: v1
The tag value of the endpoint user tag.
- Must be 0 to 255 characters.
- Case-sensitive. Must not start or end with a space.
- May include letters, numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), minus signs (-) and at signs (@).
tip
To provide this parameter, provide Tags.N.Key first.
Response parameters
RequestId String optional Example: 0ED8D006-F706-4D23-88ED-E11ED28D****
Request ID.
EndpointId String optional Example: gwep-273yuq6q7bgn47fap8squ****
ID of the gateway endpoint.
Request examples
GET /?Action=CreateVpcGatewayEndpoint&Version=2020-04-01&VpcId=vpc-bp15zkdt37pq72zv****&ServiceId=gwepsvc-2fe630gurkl37k5gfuy33****&EndpointName=endpoint-01&ClientToken=123e4567-e89b-12d3-a456-42665544****&Description=GatewayEndpoint&ProjectName=default&VpcPolicy={
"Statement" : [
{
"Effect": "Allow",
"Principal": "*",
"Action": "*",
"Resource": "*"
}
]
}&Tags.1.Key=k1&Tags.1.Value=v1
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": "CreateVpcGatewayEndpoint",
"Version": "2020-04-01",
"Service": "privatelink",
"Region": "cn-guangzhou"
},
"Result": {
"EndpointId": "gwep-273yuq6q7bgn47fap8squ****",
"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.
Last updated: 2026.08.13 10:54:50
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
