文档首页/ 统一身份认证服务 IAM/ API参考（吉隆坡区域）/ API/ 自定义策略管理/ 查询自定义策略列表
更新时间：2022-08-16 GMT+08:00
查看PDF
分享

查询自定义策略列表

功能介绍

该接口可以用于管理员查询自定义策略列表。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。

URI

GET /v3.0/OS-ROLE/roles

表1 Query参数

参数

是否必选

参数类型

描述

page

否

Integer

分页查询时数据的页数，查询值最小为1。需要与per_page同时存在。

per_page

否

Integer

分页查询时每页的数据个数，取值范围为[1,300]。需要与page同时存在。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-Auth-Token

是

String

拥有Security Administrator权限的token。

响应参数

表3 响应Body参数

参数

参数类型

描述

links

Object

资源链接信息。

roles

Array of objects

自定义策略信息列表。

total_number

Integer

返回自定义策略的总条数。
表4 links

参数

参数类型

描述

self

String

资源链接地址。

previous

String

前一邻接资源链接地址。

next

String

后一邻接资源链接地址。
表5 roles

参数

参数类型

描述

domain_id

String

自定义策略所属账号ID。

references

Integer

自定义策略的引用次数。

updated_time

String

自定义策略更新时间。

created_time

String

自定义策略创建时间。

description_cn

String

自定义策略的中文描述信息。

catalog

String

自定义策略所在目录。

name

String

自定义策略名。

description

String

自定义策略的描述信息。

links

Object

自定义策略的资源链接信息。

id

String

自定义策略ID。

display_name

String

自定义策略展示名。

type

String

自定义策略的显示模式。

说明：
  • AX表示在domain层显示。
  • XA表示在project层显示。
  • 自定义策略的显示模式只能为AX或者XA，不能在domain层和project层都显示（AA），或者在domain层和project层都不显示（XX）。

policy

Object

自定义策略的具体内容。
表6 roles.links

参数

参数类型

描述

self

String

资源链接地址。
表7 roles.policy

参数

参数类型

描述

Version

String

权限版本号。

说明：
  • 1.0：系统预置的角色。以服务为粒度，提供有限的服务相关角色用于授权。
  • 1.1：策略。IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。

Statement

Array of objects

授权语句，描述自定义策略的具体内容，不超过8个。
表8 roles.policy.Statement

参数

参数类型

描述

Action

Array of strings

授权项，指对资源的具体操作权限，不超过100个。

说明：
  • 格式为：服务名:资源类型:操作，例：vpc:ports:create。
  • 服务名为产品名称，例如ecs、evs和vpc等，服务名仅支持小写。 资源类型和操作没有大小写，要求支持通配符号*，无需罗列全部授权项。
  • 当自定义策略为委托自定义策略时，该字段值为： "Action": ["iam:agencies:assume"]。

Effect

String

作用。包含两种：允许（Allow）和拒绝（Deny），既有Allow又有Deny的授权语句时，遵循Deny优先的原则。

Condition

Object

限制条件。不超过10个。

Resource

Array of strings

资源。数组长度不超过10，每个字符串长度不超过128，规则如下：

说明：
  • 可填 * 的五段式：::::，例："obs:::bucket:*"。
  • region字段为*或用户可访问的region。service必须存在且resource属于对应service。
  • 当该自定义策略为委托自定义策略时，该字段类型为Object，值为："Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}。
表9 roles.policy.Statement.Condition

参数

参数类型

描述

operator

Object

运算符。具体运算符如 “Bool”、“StringEquals”等。

该参数类型为自定义对象。
表10 roles.policy.Statement.Condition.operator

参数

参数类型

描述

attribute

Array of strings

条件键。key为与运算符有对应关系的合法属性，value为长度不超过10的字符串数组。

该参数类型为自定义字符串数组。

请求示例

GET https://sample.domain.com/v3.0/OS-ROLE/roles

响应示例

状态码为 200 时:

请求成功。

{
  "roles" : [ {
    "domain_id" : "d78cbac186b744899480f25bd022f...",
    "updated_time" : "1579229246886",
    "created_time" : "1579229246886",
    "description_cn" : "中文描述",
    "catalog" : "CUSTOMED",
    "name" : "custom_d78cbac186b744899480f25bd022f468_1",
    "description" : "IAMDescription",
    "links" : {
      "self" : "https://sample.domain.com/v3/roles/93879fd90f1046f69e6e0b31c94d2..."
    },
    "id" : "93879fd90f1046f69e6e0b31c94d2...",
    "display_name" : "IAMCloudServicePolicy",
    "type" : "AX",
    "policy" : {
      "Version" : "1.1",
      "Statement" : [ {
        "Condition" : {
          "StringStartWith" : {
            "g:ProjectName" : [ "AZ-1" ]
          }
        },
        "Action" : [ "obs:bucket:GetBucketAcl" ],
        "Resource" : [ "obs:*:*:bucket:*" ],
        "Effect" : "Allow"
      } ]
    }
  }, {
    "domain_id" : "d78cbac186b744899480f25bd022f...",
    "updated_time" : "1579229242358",
    "created_time" : "1579229242358",
    "description_cn" : "中文描述",
    "catalog" : "CUSTOMED",
    "name" : "custom_d78cbac186b744899480f25bd022f468_0",
    "description" : "IAMDescription",
    "links" : {
      "self" : "https://sample.domain.com/v3/roles/f67224e84dc849ab954ce29fb4f47..."
    },
    "id" : "f67224e84dc849ab954ce29fb4f473...",
    "display_name" : "IAMAgencyPolicy",
    "type" : "AX",
    "policy" : {
      "Version" : "1.1",
      "Statement" : [ {
        "Action" : [ "iam:agencies:assume" ],
        "Resource" : {
          "uri" : [ "/iam/agencies/07805acaba800fdd4fbdc00b8f888..." ]
        },
        "Effect" : "Allow"
      } ]
    }
  } ],
  "links" : {
    "next" : null,
    "previous" : null,
    "self" : "https://sample.domain.com/v3/roles?domain_id=d78cbac186b744899480f25bd022f..."
  },
  "total_number" : 300
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

500

内部服务错误。

错误码

无

父主题： 自定义策略管理