Release Notes

Product Introduction

Overview

Strengths

Use Limits

Scenarios

Purchase Guide

Billing Overview

Value-Added Service Packages

Non-Standard TLDs

Getting Started

Activating Private DNS

Creating Private Domain

Deleting Private Domain

Modifying Associated VPC

Operation Guide

Setting DNS Record

Modifying DNS Record

Deleting DNS Record

Importing DNS Records

Exporting DNS Records

Associating the VPCs of Another Account

Bulk Operation

Reverse DNS and PTR Record

Subdomain Recursive DNS Description

DNS Statistics Description

Round-Robin DNS Description

Recursive Resolution Description

Cloud Access Management

Cloud Access Management Overview

Authorizable Resource Types

Sample Access Management Policy

Use Cases

Configuring the NSCD Service for Cache Acceleration to Improve DNS Availability

API Documentation

History

Introduction

API Category

Making API Requests

Private DNS APIs

Data Types

Error Codes

FAQs

Private DNS

Will Private DNS override public domain names?

PDNS Policy

Data Processing And Security Agreement

Related Agreement

Private DNS Service Level Agreement

Glossary

CreateEndPoint

PDF

Focus Mode

Font Size

Last updated: 2025-10-30 21:53:18

1. API Description

Domain name for API request: privatedns.intl.tencentcloudapi.com.

This API is used to create an endpoint.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.

3. Output Parameters

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.

4. Example

Example1 Creating an Endpoint

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.

Input Example

POST / HTTP/1.1
Host: privatedns.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEndPoint
<Common request parameters>

{
    "EndPointName": "Endpoint name.",
    "EndPointServiceId": "vpcsvc-gtd4gxa1",
    "EndPointRegion": "ap-guangzhou"
}

Output Example

{
    "Response": {
        "RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
        "EndPointId": "eid-scls023kfns",
        "EndPointName": "Endpoint name.",
        "EndPointServiceId": "vpcsvc-gtd4gxa1",
        "EndPointVipSet": [
            "10.0.0.13"
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Help and Support

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

tencent cloud