tencent cloud

Feedback

DescribeVpcEndPointServiceWhiteList

Last updated: 2022-03-31 16:51:11

1. API Description

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

This API is used to query the endpoint service allowlist.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeVpcEndPointServiceWhiteList.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of results per page; default value: 20; maximum value: 100.
Filters.N No Array of Filter Filter condition
  • user-uin - String - (Filter condition) UIN.
  • end-point-service-id - String - (Filter condition) Endpoint service ID.
  • 3. Output Parameters

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

    4. Example

    Example1 DescribeVpcEndPointServiceWhiteList

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeVpcEndPointServiceWhiteList
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "VpcEndpointServiceUserSet": [
          {
            "Owner": 1254277469,
            "UserUin": "100016184089",
            "Description": "Description",
            "EndPointServiceId": "",
            "CreateTime": "vpcsvc-kngiybxl"
          }
        ],
        "RequestId": "7e6f5074-e4a2-4bb6-9cac-d2357a00896f"
      }
    }
    

    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.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameterValue.Malformed Invalid input parameter format.
    UnsupportedOperation.UinNotFound The account ID does not 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