检索共享资源权限列表 - ListPermissions
功能介绍
检索指定资源类型的共享资源权限列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ram:permissions:list
List
permission *
-
-
-
URI
GET /v1/permissions
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页页面的大小。 约束限制: 不涉及 取值范围: 只支持数字,最小值为 1,最大值为 2000 默认取值: 2000 |
| marker | 否 | String | 参数解释: 页面标记,基于上一页页面标记取值,空字符串表明查询第一页。 约束限制: 不涉及 取值范围: 只支持数字,最小值为 1,最大值为 64 默认取值: 不涉及 |
| resource_type | 否 | String | 参数解释: 资源类型的名称。 约束限制: 仅支持 RAM 支持共享的资源类型(vpc:subnet,dns:zone,dns:resolverRule,scm:cert,pca:ca,er:instances,functiongraph:function,anc:service,anc:anc,nat:transitSubnet,kms:KeyId) 取值范围: 1-64 位字符串 默认取值: 不涉及 |
| permission_type | 否 | String | 参数解释: 权限类型。 约束限制: 不涉及 取值范围: 仅支持 RAM_MANAGED,CUSTOMER_MANAGED,ALL 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为至少 1 个字符 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| permissions | Array of PermissionSummary objects | 参数解释: 共享资源权限的详细信息列表。 约束限制: 不涉及 |
| page_info | PageInfo object | 参数解释: 分页详细信息。包含 previous_marker,next_marker 与 current_count 字段 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 权限ID。 约束限制: 不涉及 取值范围: 由[0-36]个字符组成 默认取值: 不涉及 |
| name | String | 参数解释: 权限名称。 约束限制: 不涉及 取值范围: 由[1-128]个字符组成 默认取值: 不涉及 |
| resource_type | String | 参数解释: 此权限适用的资源类型。 约束限制: 不涉及 取值范围: 由[0-100]个字符组成 默认取值: 不涉及 |
| is_resource_type_default | Boolean | 参数解释: 该权限是否是此资源类型的默认权限。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| created_at | String | 参数解释: 权限的创建时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 不涉及 |
| updated_at | String | 参数解释: 上次更新权限的时间。 约束限制: 不涉及 取值范围: 对应 RFC 3339 规范的日期时间格式,yyyy-MM-ddTHH:mm:ss.SSSZ 默认取值: 不涉及 |
| permission_urn | String | 参数解释: 权限URN。 约束限制: 不涉及 取值范围: 由[1-1500]个字符组成 默认取值: 不涉及 |
| permission_type | String | 参数解释: 权限类型,RAM托管或者租户自定义权限。 约束限制: 不涉及 取值范围: 由[0-64]个字符组成 默认取值: 不涉及 |
| default_version | Boolean | 参数解释: 此此权限是否是默认版本。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| version | Integer | 参数解释: 权限版本。 约束限制: 不涉及 取值范围: 仅支持数字,范围为 [0-1000000] 默认取值: 不涉及 |
| status | String | 参数解释: 权限的状态 约束限制: 不涉及 取值范围: 由[0-64]个字符组成 默认取值: 不涉及 |
请求示例
检索指定资源类型的共享资源权限列表。
GET /v1/permissions
响应示例
状态码:200
请求成功。
{
"permissions" : [ {
"id" : "string",
"name" : "string",
"resource_type" : "string",
"is_resource_type_default" : true,
"created_at" : "2022-09-19T02:02:18.155Z",
"updated_at" : "2022-09-19T02:02:18.155Z",
"permission_urn" : "string",
"permission_type" : "string",
"default_version" : false,
"version" : 1,
"status" : "string"
} ],
"page_info" : {
"previous_marker" : "string",
"next_marker" : "string",
"current_count" : 2000
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
错误码
请参见错误码。