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}
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
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. Default: application/json |
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
permissions |
Array of EpsPermission objects |
Specifies the whitelist of the VPC endpoint service. |
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.
Minimum: 1 Maximum: 1024 |
permission_type |
String |
Specifies the whitelist type of the VPC endpoint service.
|
description |
String |
Specifies the description of a whitelist record of a VPC endpoint service. Minimum: 0 Maximum: 256 |
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" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The server has successfully processed the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot