Obtaining List of VPC Endpoints Authorized by a Tenant

Function

This API is used to obtain the VPC endpoint access control list authorized by a tenant. Before calling this API, make sure the security access control policy does exist.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/vpceps

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_id	Yes	String	Definition Tenant ID. For details about how to obtain the account ID, see Obtaining an Account ID. Constraints N/A Range Enter 1 to 40 characters. Only digits, letters, underlines (_), and hyphens (-) are allowed. Default Value N/A
vpcep_ids	No	String	Definition The list of queried VPC endpoint IDs. Check them from the All Account Settings > General > Internal Secure Access page. Constraints N/A Range Enter 1 to 1,229 characters. Only use digits, lower-case letters, and hyphens (-). Default Value N/A
offset	No	Integer	Definition Offset. Constraints N/A Range The value ranges from 0 to 9,999. Default Value N/A
limit	No	Integer	Definition Page size. Constraints N/A Range The value ranges from 1 to 100. Default Value N/A
sort	No	String	Definition Sorting by vpcep_id. Constraints N/A Range ● asc\|ASC: ascending order. ● desc\|DESC: descending order. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (It is the value obtained from X-Subject-Token in the response header.) It can be obtained by calling the API for obtaining an IAM user token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A Default Value N/A
region	Yes	String	Definition Region where the VPC endpoint to be queried is located. It can be found from the region column in the Endpoint list. Constraints N/A Range Enter 1 to 40 characters. Only digits, letters, and hyphens (-) are allowed. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition Status. Range ● ok: The API is successfully called.
data	TenantVpcepInfos object	Definition Tenant and their authorized VPC endpoints. Range N/A
limit	Integer	Definition Page size. Range 0 to 100.
offset	Integer	Definition Offset. Range 0 to 9,999.
total	Integer	Definition Total data volume. Range N/A

**Table 4** TenantVpcepInfos
Parameter	Type	Description
enterprise_id	String	Definition Tenant ID. Range Enter 1 to 40 characters. Only digits, letters, underlines (_), and hyphens (-) are allowed.
vpceps	Array of VpcepInfo objects	Definition Information about the authorized VPC endpoints. Range N/A

**Table 5** VpcepInfo
Parameter	Type	Description
create_time	String	Definition Creation time. Range N/A
creator	String	Definition Creator. Range N/A
description	String	Definition VPC endpoint description. Range N/A
modify_time	String	Definition Modification time. Range N/A
region	String	Definition Site. Range Enter 1 to 40 characters. Only use digits, lower-case letters, and hyphens (-).
vpcep_id	String	Definition VPC endpoint ID. Range Enter 1 to 40 characters. Only use digits, lower-case letters, and hyphens (-).

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A.
error_msg	String	Definition Error message. Range N/A.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A.
error_msg	String	Definition Error message. Range N/A.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A.
error_msg	String	Definition Error message. Range N/A.

Example Requests

GET https://{endpoint}/v2/vpceps?enterprise_id=a8dd901e70f2485cb4f1fa2264eb3add&vpcep_ids=a8dd901e70f2485cb4f1fa2264eb3add,00120e895121420aa2c81870d09756b2&sort=asc

Example Responses

Status code: 200

List of VPC endpoints authorized by the tenant.

{
  "data" : {
    "enterprise_id" : "a8dd901e70f2485cb4f1fa2264eb3add",
    "vpceps" : [ {
      "vpcep_id" : "a8dd901e70f2485cb4f1fa2264eb3add",
      "description" : "VPCEP1",
      "creator" : "user001",
      "create_time" : "2026-05-01T10:30:001Z",
      "modify_time" : "2026-05-01T10:30:001Z",
      "region" : "cn-north-7"
    }, {
      "vpcep_id" : "00120e895121420aa2c81870d09756b2",
      "description" : "VPCEP2",
      "creator" : "user002",
      "create_time" : "2026-05-02T14:20:001Z",
      "modify_time" : "2026-05-03T09:15:001Z",
      "region" : "cn-east-3"
    } ]
  },
  "offset" : 0,
  "limit" : 10,
  "total" : 2
}

Status Codes

Status Code	Description
200	List of VPC endpoints authorized by the tenant.
400	Invalid parameter.
401	Insufficient permissions.
404	Not found.

Error Codes

See Error Codes.

Parent topic: VPC endpoint management

Previous topic: Deleting VPC Endpoint Access Control Information

Next topic: Permissions and Supported Actions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot