Help Center/ API Gateway/ API Reference (Kuala Lumpur Region)/ Dedicated Gateway APIs (V2)/ VPC Endpoint Management/ Querying Whitelist Records of a VPC Endpoint Service
Updated on 2024-08-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Whitelist Records of a VPC Endpoint Service

Function

This API is used to query the whitelist records of a gateway's VPC endpoint service.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.

Minimum: 1

Maximum: 500

Default: 20

permission

No

String

Permission account ID in format "iam:domain::domain_id". Fuzzy search is supported.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

x-request-id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

permissions

Array of EndpointPermission objects

Whitelist records.
Table 6 EndpointPermission

Parameter

Type

Description

id

String

Record ID.

permission

String

Permission rules.

created_at

String

Creation time.

Status code: 401

Table 7 Response header parameters

Parameter

Type

Description

x-request-id

String

Request ID.
Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 9 Response header parameters

Parameter

Type

Description

x-request-id

String

Request ID.
Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 11 Response header parameters

Parameter

Type

Description

x-request-id

String

Request ID.
Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 13 Response header parameters

Parameter

Type

Description

x-request-id

String

Request ID.
Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 2,
  "size" : 1,
  "permissions" : [ {
    "id" : "e4a7ba21-1e5c-43cc-977d-4aeeacb937ec",
    "permission" : "iam:domain::821a2d452de64bcdb52319967f8a06b9",
    "created_at" : "2021-05-07T14:10:49Z"
  } ]
}

Status code: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Status code: 404

Resource Not Found

{
  "error_code" : "APIC.7314",
  "error_msg" : "Endpoint service not found"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIC.9007",
  "error_msg" : "Failed to execute VCPEP request"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: VPC Endpoint Management