文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 密钥授权管理/ 查询可退役授权列表 - ListRetirableGrants
更新时间:2026-05-20 GMT+08:00
分享

查询可退役授权列表 - ListRetirableGrants

功能介绍

  • 功能介绍:查询用户可以退役的授权列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms::listRetirableGrants

    List

    -

    -

    kms:grant:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

limit

String

参数解释:

指定查询可退役授权返回记录条数

约束限制:

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

取值范围:

不涉及

默认取值:

1000

marker

String

参数解释:

分页查询起始位置标识

约束限制:

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

取值范围:

不涉及

默认取值:

不涉及

sequence

String

参数解释:

请求消息序列号,36字节序列号,例如:919c82d4-8046-4722-9094-35c3c6524cff

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

grants

Array of Grants objects

参数解释:

可退役授权列表

取值范围:

不涉及

next_marker

String

参数解释:

下一页所需要传递的marker值

取值范围:

不涉及

total

Integer

参数解释:

可退役授权总条数

取值范围:

不涉及

truncated

String

参数解释:

是否还有下一页

取值范围:

  • “true” 表示还有数据

  • “false” 表示已经是最后一页

表5 Grants

参数

参数类型

描述

key_id

String

参数解释:

密钥ID

取值范围:

不涉及

grant_id

String

参数解释:

授权ID

取值范围:

不涉及

grantee_principal

String

参数解释:

被授权用户ID

取值范围:

不涉及

grantee_principal_type

String

参数解释:

授权类型

取值范围:

  • user

  • domain

operations

Array of strings

参数解释:

授权允许的操作列表

取值范围:

  • “create-datakey” 创建数据密钥

  • “create-datakey-without-plaintext” 创建不含明文数据密钥

  • “encrypt-datakey” 加密数据密钥

  • “decrypt-datakey” 解密数据密钥

  • “describe-key” 查询密钥信息

  • “retire-grant” 退役授权

  • “encrypt-data” 加密数据

  • “decrypt-data” 解密数据

issuing_principal

String

参数解释:

创建授权用户ID

取值范围:

不涉及

creation_date

String

参数解释:

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

取值范围:

不涉及

name

String

参数解释:

授权名称

取值范围:

不涉及

retiring_principal

String

参数解释:

可退役授权的用户ID

取值范围:

不涉及

请求示例

查询至多1000条当前项目可退役的授权列表。

{
  "limit" : "1000"
}

响应示例

状态码: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"
}

SDK代码示例

SDK代码示例如下。

查询至多1000条当前项目可退役的授权列表。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kms.v2.region.KmsRegion;
import com.huaweicloud.sdk.kms.v2.*;
import com.huaweicloud.sdk.kms.v2.model.*;


public class ListRetirableGrantsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KmsClient client = KmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRetirableGrantsRequest request = new ListRetirableGrantsRequest();
        ListRetirableGrantsRequestBody body = new ListRetirableGrantsRequestBody();
        body.withLimit("1000");
        request.withBody(body);
        try {
            ListRetirableGrantsResponse response = client.listRetirableGrants(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

查询至多1000条当前项目可退役的授权列表。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkms.v2.region.kms_region import KmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkms.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRetirableGrantsRequest()
        request.body = ListRetirableGrantsRequestBody(
            limit="1000"
        )
        response = client.list_retirable_grants(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

查询至多1000条当前项目可退役的授权列表。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := kms.KmsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kms.NewKmsClient(hcClient)

    request := &model.ListRetirableGrantsRequest{}
	limitListRetirableGrantsRequestBody:= "1000"
	request.Body = &model.ListRetirableGrantsRequestBody{
		Limit: &limitListRetirableGrantsRequestBody,
	}
	response, err := client.ListRetirableGrants(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档