tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeEndPointList

Last updated: 2024-11-07 18:45:09

1. API Description

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

This API is used to obtain the endpoint list.

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: DescribeEndPointList.
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.
Offset No Integer Pagination offset, starting from 0.
Limit No Integer Pagination limit. Maximum value: 100. Default value: 20.
Filters.N No Array of Filter Filter parameters. Valid values: EndPointName, EndPointId, EndPointServiceId, and EndPointVip.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of endpoints.
EndPointSet Array of EndPointInfo Endpoint list.
Note: This field may return null, indicating that no valid values can be obtained.
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 Obtaining the Endpoint List

Input Example

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

{
    "Limit": 200,
    "Offset": 0,
    "Filters": [
        {
            "Name": "EndPointName",
            "Values": [
                "Endpoint name."
            ]
        },
        {
            "Name": "EndPointId",
            "Values": [
                "eid-24ed8e6319"
            ]
        },
        {
            "Name": "EndPointServiceId",
            "Values": [
                "vpcsvc-prvrnrlt"
            ]
        },
        {
            "Name": "EndPointVip",
            "Values": [
                "11.149.7.14",
                "11.149.7.141"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "8a4ea9cc-b1df-f8f8-ffe7efbe98f9ff85",
        "TotalCount": 5,
        "EndPointSet": [
            {
                "EndPointId": "eid-24ed8e6319",
                "EndPointName": "Name.",
                "EndPointServiceId": "vpcsvc-prvrnrlt",
                "EndPointVipSet": [
                    "10.0.0.17:53"
                ],
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ]
            }
        ]
    }
}

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.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
OperationDenied The operation was denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy