文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 查询终端节点服务的白名单列表
更新时间:2022-04-27 GMT+08:00
分享

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

功能介绍

查询当前用户下终端节点服务的白名单列表。

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

调试

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

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

vpc_endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

permission

String

权限帐号ID,格式为 “iam:domain::domain_id”。 其中“domain_id”为授权用户的帐号ID,例如“iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d”。 支持模糊搜索。

最小长度:1

最大长度:1000

limit

Integer

查询返回终端节点服务的白名单数量限制,即每页返回的个数。

取值范围:0~500,取值一般为 10,20或者50,默认为10。

最小值:1

缺省值:10

最小长度:0

最大长度:500

offset

Integer

偏移量。

偏移量为一个大于0小于终端节点服务总个数的整数,表示从偏移量后面的终端节点服务开始查询。

最小值:0

sort_key

String

查询结果中白名单列表的排序字段。

取值为create_at,表示白名单的添加时间。

缺省值:create_at

最小长度:1

最大长度:32

sort_dir

String

查询结果中白名单列表的排序方式,

取值为:

  • desc:降序排序
  • asc:升序排序

缺省值:desc

最小长度:1

最大长度:32

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:2048

Content-Type

String

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

最小长度:1

最大长度:64

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

permissions

Array of Permission objects

permission列表。

total_count

Integer

满足查询条件的终端节点服务的白名单总条数,不受分页(即limit、offset参数)影响。

表5 Permission

参数

参数类型

描述

id

String

permission的ID,唯一标识。

permission

String

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

created_at

String

白名单的添加时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH: MM:SSZ

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

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

表7 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error

Error object

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

表9 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error

Error object

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

表11 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error

Error object

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

表13 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 405

表14 响应Body参数

参数

参数类型

描述

error

Error object

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

表15 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 406

表16 响应Body参数

参数

参数类型

描述

error

Error object

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

表17 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 407

表18 响应Body参数

参数

参数类型

描述

error

Error object

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

表19 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 408

表20 响应Body参数

参数

参数类型

描述

error

Error object

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

表21 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 409

表22 响应Body参数

参数

参数类型

描述

error

Error object

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

表23 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 500

表24 响应Body参数

参数

参数类型

描述

error

Error object

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

表25 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 501

表26 响应Body参数

参数

参数类型

描述

error

Error object

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

表27 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 502

表28 响应Body参数

参数

参数类型

描述

error

Error object

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

表29 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 503

表30 响应Body参数

参数

参数类型

描述

error

Error object

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

表31 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 504

表32 响应Body参数

参数

参数类型

描述

error

Error object

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

表33 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions?permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset}

查询终端节点服务ID为“4189d3c2-8882-4871-a3c2-d380272eed88”的白名单列表。
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions

响应示例

状态码: 200

服务器已成功处理了请求

{
  "permissions" : [ {
    "id" : "f2659906-c622-480a-83e9-ef42bdb67b90",
    "permission" : "*",
    "created_at" : "2018-10-18T13:26:40Z"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

500

请求未完成。服务异常

501

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

502

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

503

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

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品

close