文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 更新终端节点服务白名单描述
更新时间:2024-04-19 GMT+08:00

更新终端节点服务白名单描述

功能介绍

更新当前用户下终端节点服务白名单的描述信息

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

permission_id

String

白名单的ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

permission

EpsUpdatePermissionDesc object

更新终端节点服务白名单描述的请求体

表4 EpsUpdatePermissionDesc

参数

是否必选

参数类型

描述

description

String

终端节点服务白名单描述

最小长度:0

最大长度:256

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

permissions

Array of EpsPermission objects

终端节点服务白名单

表6 EpsPermission

参数

参数类型

描述

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/*

最小长度:1

最大长度:1024

permission_type

String

终端节点服务白名单类型。

  • domainId:基于账户ID配置终端节点服务白名单。
  • orgPath:基于账户所在组织路径配置终端节点服务白名单。

description

String

终端节点服务白名单描述

最小长度:0

最大长度:256

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" : "*",
    "description" : "终端节点服务添加白名单",
    "created_at" : "2022-06-16T09:48:21Z"
  } ]
}

SDK代码示例

SDK代码示例如下。

更新终端节点服务白名单描述

 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("终端节点服务添加白名单");
        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());
        }
    }
}

更新终端节点服务白名单描述

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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="终端节点服务添加白名单"
        )
        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)

更新终端节点服务白名单描述

 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: "终端节点服务添加白名单",
	}
	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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码