更新时间:2024-04-15 GMT+08:00

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

功能介绍

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

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

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions?permission={permission}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}

参数说明如表1所示。
表1 参数说明

参数

是否必选

描述

project_id

项目ID,获取方法请参见获取项目ID

vpc_endpoint_service_id

终端节点服务的ID。

表2 查询参数

名称

是否必选

参数类型

描述

permission

String

权限账号ID,格式为“iam:domain::domain_id”。

其中“domain_id”为授权用户的账号ID,例如“iam:domain::6e9dfd51d1124e8d8498dce894923a0d”。

支持模糊搜索。

limit

Integer

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

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

offset

Integer

偏移量。

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

sort_key

String

查询结果中白名单列表的排序字段,取值为created_at,表示白名单的添加时间。

sort_dir

String

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

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

默认值为desc。

请求消息

  • 参数说明

    无。

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

响应消息

  • 参数说明
    表3 响应参数

    参数

    参数类型

    描述

    permissions

    Array of objects

    permission列表,详细内容请参见表4

    total_count

    Integer

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

    表4 permissions要素说明

    属性

    参数类型

    描述

    id

    String

    permission的ID,唯一标识。

    permission

    String

    permission列表。

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

    description

    String

    终端节点服务白名单规则的描述。最大长度不超过128个字符,支持中文字符,不支持特殊字符“<” 和“>”。

    created_at

    String

    白名单的添加时间。

    采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

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

状态码

状态码请参见状态码