查询授权列表
功能介绍
功能介绍:查询密钥的授权列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1.0/{project_id}/kms/list-grants
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
grants |
Array of Grants objects |
grant列表,详情请参见grants字段数据结构说明。 |
next_marker |
String |
获取下一页所需要传递的marker值。 当“truncated”为“false”时,“next_marker”为空。 |
truncated |
String |
是否还有下一页:
|
total |
Integer |
grant总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
key_id |
String |
密钥ID。 |
grant_id |
String |
授权ID,64字节。 |
grantee_principal |
String |
被授权用户ID,1~64字节,满足正则匹配“^[a-zA-Z0-9]{1,64}$”。 例如:0d0466b00d0466b00d0466b00d0466b0 |
grantee_principal_type |
String |
授权类型。 有效值:“user”,“domain”。 |
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 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
请求示例
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f" }
响应示例
状态码: 200
请求已成功
{ "grants" : [ { "operations" : [ "create-datakey", "describe-key" ], "issuing_principal" : "8b961fb414344d59825ba0c8c008c815", "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e", "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8", "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "creation_date" : "1597062260000", "grantee_principal_type" : "user" } ], "next_marker" : "", "total" : 1, "truncated" : "false" }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误 |
401 |
被请求的页面需要用户名和密码 |
403 |
认证失败 |
404 |
资源不存在,资源未找到 |
500 |
服务内部错误 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
504 |
网关超时 |
错误码
请参见错误码。