文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 更新终端节点服务白名单描述
更新时间:2024-06-28 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"
  } ]
}

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

分享:

    相关文档

    相关产品