tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVpcEndPointService

Last updated: 2023-08-23 14:11:20

1. API Description

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

This API is used to query the endpoint service 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: DescribeVpcEndPointService.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Filters.N No Array of Filter Filters. EndPointServiceIds and Filters cannot be both passed in.
  • service-id - String - Unique endpoint service ID.
  • service-name - String - Endpoint service instance name.
  • service-instance-id - String - Unique backend service ID in the format of lb-xxx.
  • service-type - String - Backend PaaS service type. It can be CLB, CDB or CRS. It defaults to CLB if not specified.
    • Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of results per page; default value: 20; maximum value: 100.
    EndPointServiceIds.N No Array of String Endpoint service ID EndPointServiceIds and Filters cannot be both passed in.
    IsListAuthorizedEndPointService No Boolean

    3. Output Parameters

    Parameter Name Type Description
    EndPointServiceSet Array of EndPointService Array of endpoint services
    TotalCount Integer Number of matched results
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of endpoint services

    This example shows you how to query the list of endpoint services.

    Input Example

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

{
    "EndPointServiceIds": [
        "vpcsvc-kngiybxl"
    ],
    "Limit": 1,
    "Offset": 1
}

    Output Example

    {
    "Response": {
        "EndPointServiceSet": [
            {
                "EndPointServiceId": "vpcsvc-pnpcflil",
                "VpcId": "vpc-hj3he929",
                "ServiceOwner": "1254277469",
                "ServiceName": "test_002",
                "ServiceVip": "10.101.1.11",
                "ServiceInstanceId": "lb-nswq8wkq",
                "AutoAcceptFlag": true,
                "EndPointCount": 1,
                "EndPointSet": [
                    {
                        "ServiceVpcId": "vpc-hj3he929",
                        "GroupSet": [
                            "sg-tyhgrwet"
                        ],
                        "ServiceName": "Test",
                        "State": "PENDING",
                        "ServiceVip": "10.101.1.11",
                        "EndPointName": "Node",
                        "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"
                    }
                ],
                "CreateTime": "0000-00-00 00:00:00",
                "ServiceType": "CLB"
            }
        ],
        "TotalCount": 1,
        "RequestId": "452e8b38-10a1-4d8a-8a31-a64b89c8f565"
    }
}

    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.
    InvalidParameter.FilterNotDict The specified filter condition should be a key-value pair.
    InvalidParameter.FilterValuesNotList The specified filter value should be a list.
    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.
    UnsupportedOperation.InstanceMismatch The specified instance resource does not match.
    UnsupportedOperation.RoleNotFound No roles available. Please confirm whether you get the authorization for the role.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy