Release Notes
Announcements
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to create an endpoint.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateVpcEndPoint. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| VpcId | Yes | String | VPC instance ID. obtain through the API DescribeVpcs. |
| SubnetId | Yes | String | Subnet instance ID. can be obtained through the DescribeSubnets api. |
| EndPointName | Yes | String | Endpoint name. limited to 60 characters. |
| EndPointServiceId | Yes | String | Endpoint service ID, which can be obtained through the DescribeVpcEndPointService api. |
| EndPointVip | No | String | Endpoint VIP. You can apply for a specified IP. |
| SecurityGroupId | No | String | Security group ID. can be obtained through the API DescribeSecurityGroups. |
| Tags.N | No | Array of Tag | List of tags to be bound, for example, [{"Key": "city", "Value": "shanghai"}]. |
| IpAddressType | No | String | Protocol type. supports Ipv4 and Ipv6. default is Ipv4. |
| Parameter Name | Type | Description |
|---|---|---|
| EndPoint | EndPoint | Endpoint details |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpcEndPoint
<Common request parameters>
{
"SubnetId": "subnet-4t7fr3fi",
"EndPointName": "point_002",
"VpcId": "vpc-coekkqtd",
"EndPointServiceId": "vpcsvc-kngiybxl"
}
{
"Response": {
"EndPoint": {
"ServiceVpcId": "vpc-hj3he929",
"VpcId": "vpc-coekkqtd",
"State": "PENDING",
"ServiceVip": "10.101.1.11",
"EndPointName": "point_002",
"GroupSet": [],
"EndPointOwner": "1302384414",
"EndPointId": "vpce-h0fk8lfc",
"SubnetId": "subnet-4t7fr3fi",
"CreateTime": "0000-00-00 00:00:00",
"EndPointServiceId": "vpcsvc-kngiybxl",
"EndPointVip": "10.0.0.8",
"ServiceName": "Service"
},
"RequestId": "fefb383a-7394-46c9-ba34-6b21e8fb3ac1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| InvalidParameterValue.Reserved | The parameter value is retained by the system. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| LimitExceeded | Quota limit is reached. |
| MissingParameter | Missing parameter. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceInsufficient.Subnet | The subnet does not have sufficient IPs. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.ServiceWhiteListNotAdded | The current user is not in the allowlist of the specified endpoint service. |
| UnauthorizedOperation.NoRealNameAuthentication | Identity verification has not been completed for the account. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.EndPointMismatchEndPointServiceCdcId | The endpoint and endpoint service have inconsistent CdcIds. |
| UnsupportedOperation.EndPointService | The endpoint service itself cannot be set as the endpoint. |
| UnsupportedOperation.InsufficientFunds | Insufficient account balance. |
| UnsupportedOperation.SnatSubnet | The SNAT subnet does not support assigning IPs. |
| UnsupportedOperation.SpecialEndPointService | The endpoint created by the specified endpoint service cannot be bound to a security group. |
| UnsupportedOperation.VpcMismatch | The resources are not in the same VPC. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback