# 更新终端节点服务白名单描述 - UpdateEndpointServicePermissionDesc #### 功能介绍 更新当前用户下终端节点服务白名单的描述信息 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpcep/vpcep_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpcep/vpcep_07_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpcep:endpointServices:updatePermissionsDescription | Write | endpointServices \* | - | vpcep:permissions:update | - | #### URI PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/{permission_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | | vpc_endpoint_service_id | 是 | String | 终端节点服务的ID。 | | permission_id | 是 | String | 白名单的ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 | | Content-Type | 否 | String | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | permission | 是 | [EpsUpdatePermissionDesc] object | 更新终端节点服务白名单描述的请求体 | 表4EpsUpdatePermissionDesc | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 是 | String | 终端节点服务白名单描述 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | permissions | Array of [EpsPermission] objects | 终端节点服务白名单 | 表6EpsPermission | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 白名单ID | | permission | String | 权限格式为：iam:domain::domain_id或者organizations:orgPath::org_path 其中： - "iam:domain::"和"organizations:orgPath::"为固定格式。 - "domain_id"为可连接用户的账号ID，org_path可连接用户的组织路径 domain_id类型支持输入包括"a\~z"、"A\~Z"、"0\~9"或者"\*"，org_path类型支持"a\~z"、"A\~Z"、"0\~9"、"/-\*?"或者"\*"。 \*"表示所有终端节点可连接。 例如：iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/\* | | permission_type | String | 终端节点服务白名单类型。 - domainId：基于账户ID配置终端节点服务白名单。 - orgPath：基于账户所在组织路径配置终端节点服务白名单。 | | description | String | 终端节点服务白名单描述 | | created_at | String | 白名单创建时间 | #### 请求示例 更新终端节点服务白名单描述 ``` PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/849046d9-7342-44ba-b2d2-367d8de6311b { "permission" : { "description" : "终端节点服务添加白名单" } } ``` #### 响应示例 **状态码：200** 服务器已成功处理了请求 ``` { "permissions" : [ { "id" : "849046d9-7342-44ba-b2d2-367d8de6311b", "permission" : "*", "permission_type" : "domainId", "description" : "终端节点服务添加白名单", "created_at" : "2022-06-16T09:48:21Z" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新终端节点服务白名单描述 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcepClient client = VpcepClient.newBuilder() .withCredential(auth) .withRegion(VpcepRegion.valueOf("")) .build(); UpdateEndpointServicePermissionDescRequest request = new UpdateEndpointServicePermissionDescRequest(); request.withVpcEndpointServiceId("{vpc_endpoint_service_id}"); request.withPermissionId("{permission_id}"); UpdateEndpointServicePermissionDescRequestBody body = new UpdateEndpointServicePermissionDescRequestBody(); EpsUpdatePermissionDesc permissionbody = new EpsUpdatePermissionDesc(); permissionbody.withDescription("终端节点服务添加白名单"); 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()); } } } ``` - [Python] 更新终端节点服务白名单描述 ``` # 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcepClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcepRegion.value_of("")) \ .build() try: request = UpdateEndpointServicePermissionDescRequest() request.vpc_endpoint_service_id = "{vpc_endpoint_service_id}" request.permission_id = "{permission_id}" permissionbody = EpsUpdatePermissionDesc( description="终端节点服务添加白名单" ) 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) ``` - [Go] 更新终端节点服务白名单描述 ``` 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := vpcep.VpcepClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpcep.NewVpcepClient(hcClient) request := &model.UpdateEndpointServicePermissionDescRequest{} request.VpcEndpointServiceId = "{vpc_endpoint_service_id}" request.PermissionId = "{permission_id}" permissionbody := &model.EpsUpdatePermissionDesc{ Description: "终端节点服务添加白名单", } request.Body = &model.UpdateEndpointServicePermissionDescRequestBody{ Permission: permissionbody, } response, err := client.UpdateEndpointServicePermissionDesc(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VPCEP/sdk?api=UpdateEndpointServicePermissionDesc)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 服务器已成功处理了请求 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpcep/ErrorCode.html)。