Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Whitelist Records of a VPC Endpoint Service

Updated on 2025-05-15 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Whitelist Records of a VPC Endpoint Service

Function

This API is used to query whitelist records of a VPC endpoint service.

Your account is in the whitelist of your own VPC endpoint service by default.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
permission	No	String	Specifies the permission account ID in iam:domain::domain_id format. domain_id indicates the account ID of the authorized user, for example, iam:domain::6e9dfd51d1124e8d8498dce894923a0d. Fuzzy search is supported.
limit	No	Integer	Specifies the number of returned whitelist records of the VPC endpoint service on each page. The value ranges from 0 to 500 and is generally 10, 20, or 50. The default number is 10.
offset	No	Integer	Specifies the offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.
sort_key	No	String	Specifies by what the VPC endpoint services are listed. create_at: VPC endpoint services are listed by creation time. update_at: VPC endpoint services are listed by update time. The default value is create_at.
sort_dir	No	String	Specifies how the whitelist records are listed. desc: indicates the descending order. asc: indicates the ascending order. The default value is desc.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	Specifies the MIME type of the request body. Default value application/json is recommended. For APIs used to upload objects or images, the MIME type varies depending on the flow type.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
permissions	Array of PermissionObject objects	Specifies the permissions.
total_count	Integer	Specifies the total number of whitelist records that meet the search criteria. The number is not affected by limit or offset.

**Table 5** PermissionObject
Parameter	Type	Description
id	String	Specifies the unique ID of the permission.
permission	String	Specifies the permissions. The permission formats are as follows: iam:domain::domain_id iam:domain:: is a fixed format. domain_id indicates the account ID of the user that can be connected. domain_id can contain a maximum of 64 characters, including only letters and digits. organizations:orgPath::org_path organizations:orgPath:: is a fixed format. org_path indicates the organization path of the user that can be connected. org_path can contain a maximum of 1,024 characters, including only letters, digits, forward slashes (/), hyphens (-), and question marks (?). You can also enter an asterisk () for domain_id* or org_path, which indicates that this VPC endpoint service allows accesses from any VPC endpoint. Examples: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/*
permission_type	String	Specifies the whitelist type of the VPC endpoint service. domainId: indicates the whitelisted ID of the account that can create VPC endpoints to connect to the VPC endpoint service. orgPath: indicates the whitelisted organization path under which accounts can create VPC endpoints to connect to the VPC endpoint service.
created_at	String	Specifies when the whitelist record was added. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.

Example Requests

Querying whitelist records of a VPC endpoint service

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions?permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset}

For example, you can call the API (GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions) to query the whitelist records of the VPC endpoint service whose ID is **4189d3c2-8882-4871-a3c2-d380272eed88**.

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "permissions" : [ {
    "id" : "f2659906-c622-480a-83e9-ef42bdb67b90",
    "permission" : "*",
    "created_at" : "2018-10-18T13:26:40Z"
  } ],
  "total_count" : 1
}