查询权限列表
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/roles
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
domain_id |
否 |
String |
账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。
说明：
|
permission_type |
否 |
String |
区分系统权限类型的参数。当domain_id参数为空时生效。
|
name |
否 |
String |
系统内部呈现的权限名称。如云目录服务CCS普通用户权限CCS User的name为ccs_user。 建议您传参display_name，不传name参数。 |
display_name |
否 |
String |
权限名称或过滤条件。该参数可以传入控制台或系统权限显示的权限名称。
|
page |
否 |
Integer |
分页查询时数据的页数，查询值最小为1。需要与per_page同时存在。传入domain_id参数查询自定义策略时，可配套使用。 |
per_page |
否 |
Integer |
分页查询时每页的数据个数，取值范围为[1,300]，默认值为300。需要与page同时存在。 不传page和per_page参数时，每页最多返回300个权限。 |
type |
否 |
String |
过滤权限的显示模式。取值范围：domain,project,all。type为domain时，返回type=AA或AX的权限；type为project时，返回type=AA或XA的权限；type为all时返回type为AA、AX、XA的权限。
说明：
|
catalog |
否 |
String |
权限所在目录。catalog值精确匹配策略的catalog字段(可以过滤服务的策略、或者自定义策略)。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
访问令牌，承载用户的身份、权限等信息。 token所需权限请参见授权项。 |
响应参数
参数 |
参数类型 |
描述 |
|---|---|---|
Object |
资源链接信息。 |
|
Array of objects |
权限信息列表。 |
|
total_number |
Integer |
返回权限的总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
domain_id |
String |
权限所属账号ID。 |
flag |
String |
该参数值为fine_grained时，标识此权限为系统内置的策略。 |
description_cn |
String |
权限的中文描述信息。 |
catalog |
String |
权限所在目录。 |
name |
String |
系统内部呈现的权限名称。如云目录服务CCS普通用户权限CCS User的name为ccs_user。 携带在用户的token中，云服务根据该名称来判断用户是否有权限访问。 |
description |
String |
权限描述信息。 |
Object |
权限的资源链接信息。 |
|
id |
String |
权限ID。 |
display_name |
String |
权限名称。 |
type |
String |
权限的显示模式。
说明：
|
Object |
权限的具体内容。 |
|
updated_time |
String |
权限更新时间。
说明：
UTC时间，格式为 YYYY-MM-DDTHH:mm:ss.ssssssZ，日期和时间戳格式参照 ISO-8601，如：2023-06-28T08:56:33.710000Z。 |
created_time |
String |
权限创建时间。
说明：
UTC时间，格式为 YYYY-MM-DDTHH:mm:ss.ssssssZ，日期和时间戳格式参照 ISO-8601，如：2023-06-28T08:56:33.710000Z。 |
参数 |
参数类型 |
描述 |
|---|---|---|
Array of objects |
该权限所依赖的权限。 |
|
Array of objects |
授权语句，描述权限的具体内容。 |
|
Version |
String |
权限版本号。
说明：
|
参数 |
参数类型 |
描述 |
|---|---|---|
Action |
Array of strings |
授权项，指对资源的具体操作权限。支持的授权项请参考各云服务《API参考》中“权限和授权项”章节。
说明：
|
Effect |
String |
作用。包含两种：允许（Allow）和拒绝（Deny），既有Allow又有Deny的授权语句时，遵循Deny优先的原则。 取值范围：
|
Condition |
Object |
限制条件。了解更多相关参数，请参考：配置自定义策略。
说明：
以请求示例中的Condition为例：条件键（obs:prefix）和字符串（public）需相等（StringEquals）。 "Condition": {
"StringEquals": {
"obs:prefix": [
"public"
]
}
}
|
Resource |
Array of strings |
资源。规则如下：
说明：
|
参数 |
参数类型 |
描述 |
|---|---|---|
attribute |
Array of strings |
条件键。key为与运算符有对应关系的合法属性，value为长度不超过10的字符串数组。 该参数类型为自定义字符串数组。 |
请求示例
查询权限列表。
GET https://iam.myhuaweicloud.com/v3/roles
响应示例
状态码为 200 时:
请求成功。
{
"roles" : [ {
"domain_id" : null,
"description_cn" : "漏洞扫描服务（VSS）管理员，拥有该服务下的所有权限",
"catalog" : "VulnScan",
"name" : "wscn_adm",
"description" : "Vulnerability Scan Service administrator of tasks and reports.",
"links" : {
"next" : null,
"previous" : null,
"self" : "https://iam.myhuaweicloud.com/v3/roles/0af84c1502f447fa9c2fa18083fbb87e"
},
"id" : "0af84c1502f447fa9c2fa18083fbb87e",
"display_name" : "VSS Administrator",
"type" : "XA",
"policy" : {
"Version" : "1.0",
"Statement" : [ {
"Action" : [ "WebScan:*:*" ],
"Effect" : "Allow"
} ],
"Depends" : [ {
"catalog" : "BASE",
"display_name" : "Server Administrator"
}, {
"catalog" : "BASE",
"display_name" : "Tenant Guest"
} ]
}
}, {
"domain_id" : null,
"flag" : "fine_grained",
"description_cn" : "微服务引擎服务管理员权限",
"catalog" : "CSE",
"name" : "system_all_34",
"description" : "All permissions of CSE service.",
"links" : {
"next" : null,
"previous" : null,
"self" : "https://iam.myhuaweicloud.com/v3/roles/0b5ea44ebdc64a24a9c372b2317f7e39"
},
"id" : "0b5ea44ebdc64a24a9c372b2317f7e39",
"display_name" : "CSE Admin",
"type" : "XA",
"policy" : {
"Version" : "1.1",
"Statement" : [ {
"Action" : [ "cse:*:*", "ecs:*:*", "evs:*:*", "vpc:*:*" ],
"Effect" : "Allow"
} ]
}
} ],
"links" : {
"next" : null,
"previous" : null,
"self" : "https://iam.myhuaweicloud.com/v3/roles"
},
"total_number" : 300
}
返回值
返回值 |
描述 |
|---|---|
200 |
请求成功。 |
400 |
参数无效。 |
401 |
认证失败。 |
403 |
没有操作权限。 |
错误码
无
