获取权限策略列表 - ListRule

功能介绍

获取权限策略列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/permissions/rules

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页获取列表时，页的大小，默认为-1
offset	否	Integer	分页获取列表时，起始偏移量，默认为0
order_by	否	String	分页获取列表时，排序参数，支持 create_at 和 update_at
order	否	String	分页获取列表时，排序方向，支持 desc 和 asc

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
items	Array of Rule objects	权限策略列表
total	Integer	所有页的结果的总数

表4 Rule
参数	参数类型	描述
kind	String	API类型。
apiVersion	String	API版本，固定值“v1”，该值不可修改。
metadata	ObjectMeta object	基本信息。
spec	RuleSpec object	spec是集合类的元素类型，您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。

表5 ObjectMeta
参数	参数类型	描述
uid	String	资源ID
name	String	资源名称
generateName	String	当未提供name时，服务器使用的前缀来生成唯一名称
namespace	String	命名空间
labels	Map<String,String>	标签
annotations	Map<String,String>	注解
creationTimestamp	String	创建时间
updateTimestamp	String	更新时间
resourceVersion	String	资源内部版本
generation	String	资源期望状态的代数
managedFields	Array of ManagedFieldsEntry objects	记录哪些字段由哪些工作流管理
ownerReferences	Array of OwnerReference objects	用于定义对象间所有权关系，管理对象的依赖关系和垃圾回收机制，支持控制器对资源的管理

表6 ManagedFieldsEntry
参数	参数类型	描述
manager	String	管理者的名称
operation	String	记录导致此条目创建的操作类型，只能是 Apply 或 Update 两种操作类型
apiVersion	String	该管理者定义字段时所依据的资源 API 版本
time	String	此管理条目被创建或最后一次更新的时间戳
fieldsType	String	固定为 "FieldsV1"，标记字段结构格式
fieldsV1	Object	用于存储实际被管理的字段信息

表7 OwnerReference
参数	参数类型	描述
apiVersion	String	标识引用对象的API版本
kind	String	引用对象的类型
name	String	引用对象的名称
uid	String	引用对象的uid
controller	Boolean	如果为true，表示该引用指向管理该资源的控制器
blockOwnerDeletion	Boolean	当为true且拥有者有名为"foregroundDeletion"的finalizer 时，会阻止拥有者被删除，直到这个引用被移除

表8 RuleSpec
参数	参数类型	描述
iamUserIDs	Array of strings	权限策略关联的IAM用户信息
type	String	权限策略类型，只允许四种类型：readonly/develop/admin/custom
contents	Array of Content objects	权限策略内容
description	String	权限策略描述信息

表9 Content
参数	参数类型	描述
verbs	Array of strings	动作列表
resources	Array of strings	资源列表

状态码：400

**表10** 响应Body参数
参数	参数类型	描述
-	String	-

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
-	String	-

请求示例

无

响应示例

状态码：200

权限策略列表

{
  "items" : [ {
    "metadata" : {
      "name" : "admin",
      "uid" : "3dcdef78-65bb-11ee-bdf2-0255ac100033",
      "creationTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC",
      "updateTimestamp" : "2023-10-08 09:15:36.526016 +0000 UTC"
    },
    "spec" : {
      "iamUserIDs" : [ "873395a21c8d4d8ba9e37d6d32debc41" ],
      "type" : "admin",
      "contents" : [ {
        "verbs" : [ "*" ],
        "resources" : [ "*" ]
      } ]
    }
  } ],
  "total" : 1
}