文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-实例终端节点管理/ 批量添加实例终端节点连接白名单
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量添加实例终端节点连接白名单

功能介绍

批量添加实例终端节点连接白名单。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions/batch-add

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

permissions

是

Array of strings

白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。

其中，授权账号ID是长度为32的字符串，只包含英文字母（a-f）或数字；也可为*，表示允许全部用户连接。

数组长度：1 - 50

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表5 响应Body参数

参数

参数类型

描述

permissions

Array of strings

白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。

其中，授权账号ID是长度为32的字符串，只包含英文字母（a-f）或数字；也可为*，表示允许全部用户连接。

数组长度：1 - 50

状态码： 401

表6 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表10 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表12 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量添加实例终端节点连接白名单

{
  "permissions" : [ "iam:domain::7cc2018e40394f7c9692f1713e76234d" ]
}

响应示例

状态码： 200

OK

{
  "permissions" : [ "iam:domain::930ba6b0ea64457e8ed1861e596c7a9a" ]
}

状态码： 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码： 404

Resource Not Found

{
  "error_code" : "APIC.7314",
  "error_msg" : "Endpoint service not found"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIC.9007",
  "error_msg" : "Failed to execute VCPEP request"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

错误码

请参见错误码。