文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 批量添加或移除终端节点服务的白名单
更新时间:2022-04-27 GMT+08:00
分享

批量添加或移除终端节点服务的白名单

功能介绍

批量添加或移除当前用户下终端节点服务的白名单。

本帐号默认在自身用户的终端节点服务的白名单中。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:2048

Content-Type

String

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

最小长度:1

最大长度:65

表3 请求Body参数

参数

是否必选

参数类型

描述

permissions

Array of strings

permission列表。 权限格式为:iam:domain::domain_id。

  • “iam:domain::”为固定格式。
  • “domain_id”为可连接用户的帐号ID。

    支持输入1~64个字符,包括“a~z”、 “A~Z”、“0~9”或者""。""表示所有终端节点可连接。

例如:iam:domain:: 6e9dfd51d1124e8d8498dce894923a0dd

action

String

要执行的操作。 取值为:

  • add:添加
  • remove:移除

最小长度:1

最大长度:32

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

permissions

Array of strings

permission列表。 权限格式为iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d或“”, “”表示所有用户的终端节点可连接。其中 6e9dfd51d1124e8d8498dce894923a0d为可连接的用户domain_id。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表6 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表8 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表10 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表12 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 405

表13 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表14 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 406

表15 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表16 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 407

表17 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表18 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 408

表19 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表20 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 409

表21 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表22 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 500

表23 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表24 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 501

表25 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表26 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 502

表27 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表28 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 503

表29 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表30 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 504

表31 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表32 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

  • 添加终端节点服务的白名单
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action
    
    {
      "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ],
      "action" : "add"
    }
  • 移除终端节点服务的白名单
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/permissions/action
    
    {
      "permissions" : [ "iam:domain::fc973eea581490997e82ea11a1d0101" ],
      "action" : "remove"
    }

响应示例

状态码: 200

服务器已成功处理了请求

{
  "permissions" : [ "iam:domain::5fc973eea581490997e82ea11a1d0101", "iam:domain::5fc973eea581490997e82ea11a1d0102" ]
}

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突,请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品

close