Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service

Updated on 2022-12-13 GMT+08:00

View PDF

Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service

Function

Function This API is used to batch add or delete whitelist records of a VPC endpoint service. Note: Your account is in the whitelist of your own VPC endpoint service by default.

URI

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum: 1 Maximum: 64
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service. Minimum: 1 Maximum: 64

Request Parameters

**Table 2** 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. Minimum: 1 Maximum: 2048
Content-Type	Yes	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. Minimum: 1 Maximum: 65

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
permissions	Yes	Array of strings	Specifies permissions. The permission format is iam:domain::domain_id. ● iam:domain:: is a fixed format. ● domain_id is the account ID of the user that can be connected. The value contains 1 to 64 characters, including letters and digits. The value also can be an asterisks (*). indicates that all tenants can create VPC endpoints to connect the VPC endpoint service. Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd
action	Yes	String	Specifies the action to be performed, which can be add or remove. Minimum: 1 Maximum: 32

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
permissions	Array of strings	Specifies permissions. The permissions format is iam:domain::6e9dfd51d1124e8d8498dce894923a0d or *. indicates that all users' VPC endpoint can be connected. iam:domain::6e9dfd51d1124e8d8498dce894923a0d is the domain ID of the user that can connect VPC endpoint services.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 6** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 8** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 10** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 12** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 405

**Table 13** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 14** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 406

**Table 15** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 16** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 407

**Table 17** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 18** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 408

**Table 19** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 20** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 409

**Table 21** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 22** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 500

**Table 23** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 24** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 501

**Table 25** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 26** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 502

**Table 27** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 28** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 503

**Table 29** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 30** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Status code: 504

**Table 31** Response body parameters
Parameter	Type	Description
error	Error object	Specifies the error message returned when a task submission exception occurs.

**Table 32** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Example Requests

Adding a Whitelist for a VPC Endpoint Service

POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action

{
  "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ],
  "action" : "add"
}

Removing a VPC Endpoint Service from the Whitelist

POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action

{
  "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ],
  "action" : "remove"
}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "permissions" : [ "iam:domain::5fc973eea581490997e82ea11a1d0101", "iam:domain::5fc973eea581490997e82ea11a1d0102" ]
}

Status Codes

Status Code	Description
200	The server has successfully processed the request.
400	The request could not be understood by the server due to malformed syntax.
401	The requested page requires a user name and password.
403	The server understood the request, but is refusing to fulfill it.
404	The requested page was not found.
405	The method specified in the request line is not allowed for the resource identified by the request URI.
406	The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
407	The client must first authenticate itself with the proxy.
408	The client did not produce a request within the time that the server was prepared to wait.
409	The request could not be completed due to a conflict with the current state of the resource.
500	Failed to complete the request. Service abnormality.
501	Failed to complete the request. The server does not support the requested function.
502	Failed to complete the request. because the server has received an invalid response.
503	Failed to complete the request. because the system is unavailable.
504	Gateway Timeout