Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Updating the Description of a Whitelist Record of a VPC Endpoint Service

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

View PDF

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

Function

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

Calling Method

For details, see Calling APIs.

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.
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service.
permission_id	Yes	String	Specifies IDs of whitelist records of a VPC endpoint service.

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.
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.

**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 whitelist of the 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 or organizations:orgPath::org_path. iam:domain:: and organizations:orgPath:: are fixed formats. domain_id indicates the ID of the account in which VPC endpoints can be created to access the VPC endpoint service. org_path indicates the organization path under which accounts can create VPC endpoints to access the VPC endpoint service. domain_id can contain only letters and digits. org_path can contain only letters, digits, forward slashes (/), and hyphens (-). 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. Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd or 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.
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.

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"
  } ]
}