Tenant Cloud Network Virtual Private Cloud Private Link APIs DescribeVpcEndPoint

DescribeVpcEndPoint

Last Updated At: 2026-08-02 00:06:19

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

Query the endpoint details

Default interface request rate limit: 20 times per second.

Interface update time: 2021-02-04 01:34:32.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeVpcEndPoint
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
Filters No No Array of Filter Filter criteria.
  • end-point-service-id String - (Filter criteria) Endpoint service ID.
  • end-point-name - String - (Filter criteria) Endpoint instance name.
  • end-point-id - String - (Filter criteria) Endpoint instance ID.
  • vpc-id - String - (Filter criteria) VPC instance ID.

    • Example:View
    Offset No No Uint64 Offset. 0 by default.
    Example: 1
    Limit No No Uint64 Number of returns per page, 20 by default, up to 100.
    Example: 1
    EndPointId No No Array of String Endpoint ID list.
    Example: vpce-fwzzlq4w
    IpAddressType No No String IP Address Type
    Example: IPv4/IPv6

    3. Output Parameters

    Parameter name Type Description
    EndPointSet Array of EndPoint Endpoint object.
    Example:View
    TotalCount Uint64 Number of endpoints that meet the query criteria.
    Example: 1
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Range The parameter value is not within the specified range.
    ResourceNotFound The resource does not exist
    InvalidParameter.Coexist The parameters must not be specified simultaneously.