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

查询实例的终端节点服务的白名单列表

功能介绍

查询当前实例终端节点服务的白名单列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

permission

否

String

权限账号ID，格式为“iam:domain::domain_id”，支持模糊搜索

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表5 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

permissions

Array of EndpointPermission objects

白名单记录列表
表6 EndpointPermission

参数

参数类型

描述

id

String

记录编号

permission

String

权限规则

created_at

String

创建时间

状态码： 401

表7 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表9 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表11 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表13 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号
表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码： 200

OK

{
  "total" : 2,
  "size" : 1,
  "permissions" : [ {
    "id" : "e4a7ba21-1e5c-43cc-977d-4aeeacb937ec",
    "permission" : "iam:domain::821a2d452de64bcdb52319967f8a06b9",
    "created_at" : "2021-05-07T14:10:49Z"
  } ]
}

状态码： 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

错误码

请参见错误码。

相关文档