DescribeVpcEndPointService

最后更新时间：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 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	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 service-id - String - (Filter condition) Unique endpoint service ID. service-name - String - (Filter condition) Endpoint service instance name. service-instance-id - String - (Filter condition) Unique real server ID in the format of `lb-xxx`.
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

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 endpoint service list

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": {
    "TotalCount": 1,
    "EndPointServiceSet": [
      {
        "VpcId": "vpc-hj3he929",
        "EndPointSet": {},
        "AutoAcceptFlag": "False",
        "ServiceInstanceId": "lb-nswq8wkq",
        "ServiceName": "test_002",
        "EndPointServiceId": "vpcsvc-pnpcflil",
        "ServiceVip": "10.101.1.11",
        "CreateTime": "2021-04-12 19:22:43",
        "ServiceOwner": "1254277469",
        "EndPointCount": 0
      }
    ],
    "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

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
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.

tencent cloud

腾讯云合作伙伴网络

成为合作伙伴

国际合作伙伴学院

Recent Pages