tencent cloud

Feedback

DescribeVpcEndPoint

Last updated: 2022-05-31 16:37:52

1. API Description

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

This API is used to query the endpoint list.

A maximum of 20 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: DescribeVpcEndPoint.
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.
Filters.N No Array of Filter Filter condition
  • end-point-service-id - String - (Filter condition) Endpoint service ID.
  • end-point-name - String - (Filter condition) Endpoint instance name.
  • end-point-id - String - (Filter condition) Endpoint instance ID.
  • vpc-id - String - (Filter condition) VPC instance ID.
  • Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of results per page; default value: 20; maximum value: 100.
    EndPointId.N No Array of String Endpoint ID list

    3. Output Parameters

    Parameter Name Type Description
    EndPointSet Array of EndPoint Endpoint
    TotalCount Integer Number of matched endpoints
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the endpoint list

    Input Example

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeVpcEndPoint
    <Common request parameters>
    
    {
        "Limit": 1,
        "EndPointId": [
            "vpce-h0fk8lfc"
        ],
        "Offset": 1
    }
    

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "RequestId": "7e6f5074-e4a2-4bb6-9cac-d2357a00896f",
        "EndPointSet": [
          {
            "ServiceVpcId": "vpc-hj3he929",
            "GroupSet": [
              "sg-tyhgrwet"
            ],
            "ServiceName": "Test",
            "State": "PENDING",
            "ServiceVip": "10.101.1.11",
            "EndPointName": "Endpoint",
            "VpcId": "vpc-hj3he929",
            "EndPointOwner": "1302384414",
            "EndPointId": "vpce-h0fk8lfc",
            "SubnetId": "subnet-4t7fr3fi",
            "CreateTime": "0000-00-00 00:00:00",
            "EndPointServiceId": "vpcsvc-kngiybxl",
            "EndPointVip": "10.101.1.11"
          }
        ]
      }
    }
    

    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
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.SvcNotExist The Svc doesn't exist.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support