Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Updating the Description of a Whitelist Record of a VPC Endpoint Service
Updated on 2022-12-13 GMT+08:00

Updating the Description of a Whitelist Record of a VPC Endpoint Service

Function

Function This API is used to update the description of a whitelist record of a VPC endpoint service.

URI

PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/{permission_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 64

vpc_endpoint_service_id

Yes

String

Specifies the ID of the VPC endpoint service.

Minimum: 1

Maximum: 64

permission_id

Yes

String

Specifies IDs of whitelist records of a 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

permission

Yes

EpsUpdatePermissionDesc object

Specifies the request body for updating the description of a whitelist record of a VPC endpoint service.

Table 4 EpsUpdatePermissionDesc

Parameter

Mandatory

Type

Description

description

Yes

String

Specifies the description of a whitelist record of a VPC endpoint service.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

permissions

Array of EpsPermission objects

Specifies the response body of a whitelist record of a VPC endpoint service.

Table 6 EpsPermission

Parameter

Type

Description

id

String

Specifies primary key IDs of whitelist records of a VPC endpoint service.

permission

String

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 asterisk (*).

  • indicates that all tenants can create VPC endpoints to connect the VPC endpoint service. Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd

Minimum: 1

Maximum: 64

description

String

Specifies the description of a whitelist record of a VPC endpoint service.

created_at

String

Specifies the time when a whitelist record is created.

Status code: 400

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: 401

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: 403

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: 404

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: 405

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: 406

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: 407

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: 408

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: 409

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: 500

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: 501

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: 502

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: 503

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.

Status code: 504

Table 33 Response body parameters

Parameter

Type

Description

error

Error object

Specifies the error message returned when a task submission exception occurs.

Table 34 Error

Parameter

Type

Description

message

String

Task error description

code

String

Error code of a task exception.

Example Requests

Updating the description of a whitelist record of a VPC endpoint service

PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/849046d9-7342-44ba-b2d2-367d8de6311b

{
  "permission" : {
    "description" : "Specifies the whitelist record to the VPC endpoint service added."
  }
}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "permissions" : [ {
    "id" : "849046d9-7342-44ba-b2d2-367d8de6311b",
    "permission" : "*",
    "description" : "Specifies the whitelist record to the VPC endpoint service added.",
    "created_at" : "2022-06-16T09:48:21Z"
  } ]
}

Status Codes

Status Code

Description

200

The server has successfully processed the request.

400

The server failed to process the request.

401

Username and password are required to access the requested page.

403

The access to the requested page is forbidden.

404

The server could not find the requested page.

405

The method specified in the request is not allowed.

406

The response generated by the server could not be accepted by the client.

407

Proxy authentication is required before the request is processed.

408

The request timed out.

409

The request could not be processed due to a conflict.

500

Request failed. A service error occurred.

501

Request failed. The server does not support the requested function.

502

Request failed. The server has received an invalid response from the upstream server.

503

Request failed. The system is unavailable.

504

Gateway timed out.

Error Codes

See Error Codes.