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" } ] }
SDK Sample Code
The SDK sample code is as follows.
Updating the description of a whitelist record of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion; import com.huaweicloud.sdk.vpcep.v1.*; import com.huaweicloud.sdk.vpcep.v1.model.*; public class UpdateEndpointServicePermissionDescSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); VpcepClient client = VpcepClient.newBuilder() .withCredential(auth) .withRegion(VpcepRegion.valueOf("<YOUR REGION>")) .build(); UpdateEndpointServicePermissionDescRequest request = new UpdateEndpointServicePermissionDescRequest(); UpdateEndpointServicePermissionDescRequestBody body = new UpdateEndpointServicePermissionDescRequestBody(); EpsUpdatePermissionDesc permissionbody = new EpsUpdatePermissionDesc(); permissionbody.withDescription("Specifies the whitelist record to the VPC endpoint service added."); body.withPermission(permissionbody); request.withBody(body); try { UpdateEndpointServicePermissionDescResponse response = client.updateEndpointServicePermissionDesc(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Updating the description of a whitelist record of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpcep.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = VpcepClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcepRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateEndpointServicePermissionDescRequest() permissionbody = EpsUpdatePermissionDesc( description="Specifies the whitelist record to the VPC endpoint service added." ) request.body = UpdateEndpointServicePermissionDescRequestBody( permission=permissionbody ) response = client.update_endpoint_service_permission_desc(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Updating the description of a whitelist record of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := vpcep.NewVpcepClient( vpcep.VpcepClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateEndpointServicePermissionDescRequest{} permissionbody := &model.EpsUpdatePermissionDesc{ Description: "Specifies the whitelist record to the VPC endpoint service added.", } request.Body = &model.UpdateEndpointServicePermissionDescRequestBody{ Permission: permissionbody, } response, err := client.UpdateEndpointServicePermissionDesc(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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