文档首页 > > API参考> API说明> 管理加密密钥> 查询授权列表

查询授权列表

分享
更新时间: 2019/10/23 GMT+08:00

功能介绍

查询密钥的授权列表。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/list-grants

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_id

String

密钥ID,36字节,满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如:0d0466b0-e727-4d9c-b35d-f84bb474a37f

limit

String

指定查询授权列表返回记录条数,如果查询记录条数小于存在的条数,响应参数“truncated”将返回“true”,表示存在分页。

取值在授权最大个数范围以内。例如:100

marker

String

分页查询起始位置标识。

分页查询收到的响应参数“truncated”“true”时,可以发送连续的请求获取更多的记录条数,“marker”设置为响应的“next_marker”的值。例如:10。

sequence

String

请求消息序列号,36字节序列号。

例如:919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

grants

Array of objects

grant列表,详情请参见表4

next_marker

String

获取下一页所需要传递的marker值。

“truncated”“false”时,“next_marker”为空。

truncated

String

是否还有下一页:
  • “true”表示还有数据。
  • “false”表示已经是最后一页。

total

Integer

grant总条数。

表4 grants字段数据结构说明

参数

是否必选

参数类型

描述

key_id

String

密钥ID,36字节,满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如:0d0466b0-e727-4d9c-b35d-f84bb474a37f

grant_id

String

授权ID,64字节,满足正则匹配“^[A-Fa-f0-9]{64}$”。

例如:7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d

grantee_principal

String

被授权用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。

例如:0d0466b00d0466b00d0466b00d0466b0

operations

Array of strings

授权允许的操作列表。有效的值:“create-datakey”“create-datakey-without-plaintext”“encrypt-datakey”“decrypt-datakey”“describe-key”“create-grant”“retire-grant”“encrypt-data”“decrypt-data”

有效值不能仅为“create-grant”

issuing_principal

String

创建授权用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。

例如:0d0466b00d0466b00d0466b00d0466b0

creation_date

String

创建时间,时间戳,即从1970年1月1日至该时间的总秒数。

例如:1497341531000

name

String

授权名字,取值1到255字符,满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”。

retiring_principal

String

可退役授权的用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。

例如:0d0466b00d0466b00d0466b00d0466b0

示例

如下以查询密钥ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的授权列表为例。

  • 请求样例
    {
        "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        "limit": "",
        "marker": ""
    }
  • 响应样例
    {
        "grants": [
         {"key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
          "grant_id": "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d",
          "operations": 
          ["describe-key","create-datakey", "encrypt-datakey"],
          "grantee_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
          "retiring_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
          "issuing_principal":"e4hkeeea506ex3wgnzyhi656n8hx8xa3",
          "name":"my_grant",
          "creation_date":"1497341531000"
          }],
        "next_marker": "",
        "truncated": "false",
        "total":1
    }

    {
        "error": {
            "error_code": "KMS.XXXX",
            "error_msg": "XXX"
        }
    }

状态码

表5描述的是API返回的正常状态码。
表5 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区