tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Private DNS
    Documentation
    Download PDF

    CreateEndPointAndEndPointService

    Last updated: 2024-11-07 18:44:40
    Download PDF

    1. API Description

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

    This API is used to create an endpoint and an endpoint service simultaneously.

    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: CreateEndPointAndEndPointService.
    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.
    VpcId Yes String VPC instance ID.
    AutoAcceptFlag Yes Boolean Whether automatic forwarding is supported.
    ServiceInstanceId Yes String Backend service ID.
    EndPointName Yes String Endpoint name.
    EndPointRegion Yes String Endpoint region, which should be consistent with the region of the endpoint service.
    EndPointServiceName No String Endpoint service name.
    ServiceType No String Mounted PaaS service type. Valid values: CLB, CDB, and CRS.
    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 and an Endpoint Service Simultaneously

    This example shows you how to create an endpoint service by entering the VPC ID, endpoint service name, instance ID, and service type and how to create an endpoint by using the endpoint name and the region corresponding to the endpoint service.

    Input Example

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

{
    "VpcId": "vpc-xxxxxxxx",
    "EndPointServiceName": "test001",
    "AutoAcceptFlag": true,
    "ServiceInstanceId": "lb-xxxxxxxx",
    "ServiceType": "clb",
    "EndPointName": "test001",
    "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

    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.EndPointServiceCreateFailed Failed to create an endpoint service.
    FailedOperation.EndPointServiceDeleteFailed Failed to delete the endpoint service.
    FailedOperation.EndPointServiceWhiteListFailed Failed to obtain the endpoint service allowlist.
    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.
    ResourceInUse The resource is in use.
    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.UnauthorizedAccount Unverified user.
    UnknownParameter Unknown parameter.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy