Domain name for API request: privatedns.tencentcloudapi.com.
This API is used to create an endpoint.
A maximum of 10 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: CreateEndPoint. |
Version | Yes | String | Common Params. The value used for this API: 2020-10-28. |
Region | No | String | Common Params. This parameter is not required for this API. |
EndPointName | Yes | String | Endpoint name. |
EndPointServiceId | Yes | String | Endpoint service ID (namely, VPC endpoint service ID). |
EndPointRegion | Yes | String | Endpoint region, which should be consistent with the region of the endpoint service. |
IpNum | No | Integer | Number of endpoint IP addresses. |
Parameter Name | Type | Description |
---|---|---|
EndPointId | String | Endpoint ID. |
EndPointName | String | Endpoint name. |
EndPointServiceId | String | Endpoint service ID. |
EndPointVipSet | Array of String | IP address list of the endpoint. |
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. |
This example shows you how to create an endpoint by entering the endpoint name, customer's endpoint service ID, and region corresponding to the endpoint service.
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEndPoint
<Common request parameters>
{
"EndPointName": "Endpoint name.",
"EndPointServiceId": "vpcsvc-gtd4gxa1",
"EndPointRegion": "ap-guangzhou"
}
{
"Response": {
"RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
"EndPointId": "eid-scls023kfns",
"EndPointName": "Endpoint name.",
"EndPointServiceId": "vpcsvc-gtd4gxa1",
"EndPointVipSet": [
"10.0.0.13"
]
}
}
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 |
---|---|
AuthFailure | Error with CAM signature/authentication. |
FailedOperation | Operation failed. |
FailedOperation.CreateVpcEndPointError | An exception occurs when you create an endpoint. |
FailedOperation.CreateVpcEndPointFailed | Failed to create an endpoint. |
FailedOperation.GetTmpCredFailed | Failed to obtain the temporary credential. |
InternalError | Internal error. |
InternalError.UndefiendError | Undefined error. |
InvalidParameter | Incorrect parameter. |
InvalidParameter.EndPointServiceNotExist | The endpoint service does not exist. |
InvalidParameterValue.UinNotInWhiteList | No access permission because the UIN is not added to the allowlist. |
MissingParameter | Missing parameter. |
OperationDenied | The operation was denied. |
ResourceInsufficient | Insufficient resource. |
ResourceNotFound.ServiceNotSubscribed | The Private DNS service is not activated. |
ResourceUnavailable | The resource is unavailable. |
ResourceUnavailable.ServiceWhiteListNotAdded | The platform account is not added to the allowlist of the current endpoint service. |
UnauthorizedOperation | Unauthorized operation. |
UnauthorizedOperation.RoleUnAuthorized | Role not authorized. |
UnauthorizedOperation.UnauthorizedAccount | Unverified user. |
UnknownParameter | Unknown parameter. |
Was this page helpful?