查询终端节点服务的白名单列表 - ListServicePermissionsDetails
功能介绍
查询当前用户下终端节点服务的白名单列表。
说明
本账号默认在当前用户下终端节点服务的白名单中。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
vpcep:endpointServices:listPermissions
List
endpointServices *
-
- vpcep:permissions:list
-
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
vpc_endpoint_service_id |
是 |
String |
终端节点服务的ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
查询结果中终端节点服务列表的排序字段，取值为：
默认值为create_at。 |
|
sort_dir |
否 |
String |
查询结果中白名单列表的排序方式，取值为：
默认值为desc。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
permissions |
Array of PermissionObject objects |
permission列表。 |
|
total_count |
Integer |
满足查询条件的终端节点服务的白名单总条数，不受分页（即limit、offset参数）影响。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
permission的ID，唯一标识。 |
|
permission |
String |
permission列表。 权限格式为：
“iam:domain::”为固定格式，“domain_id”为可连接用户的账号ID。 domain_id类型支持输入包括“a~z”、“A~Z”、“0~9”或者“*”，最大长度可以传64。 “organizations:orgPath::”为固定格式，org_path为可连接用户的组织路径。 org_path类型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”，最大长度可以传1024。 “*”表示所有终端节点可连接。 示例：
|
|
permission_type |
String |
终端节点服务白名单类型。
|
|
created_at |
String |
白名单的添加时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ |
请求示例
查询终端节点服务的白名单列表
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 |
服务器已成功处理了请求 |
错误码
请参见错误码。
