更新时间:2026-05-20 GMT+08:00
分享

查询密钥列表 - ListKeys

功能介绍

  • 功能介绍:查询用户所有密钥列表。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms:cmk:list

    List

    KeyId *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

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

表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

参数解释:

指定查询返回记录条数

约束限制:

limit的值需为整数

取值范围:

1-2000

默认取值:

2000

marker

String

参数解释:

分页查询起始位置标识,“marker”设置为上一页响应体中的next_marker的值

约束限制:

marker需要和limit配合使用,不能独立使用。当最后一页返回数量小于limit时,表示查询结束。

取值范围:

不涉及

默认取值:

不涉及

key_state

String

参数解释:

密钥状态

约束限制:

满足正则匹配“^[1-5]{1}$”

取值范围:

  • “1”表示待激活状态

  • “2”表示启用状态

  • “3”表示禁用状态

  • “4”表示计划删除状态

  • “5”表示等待导入状态

默认取值:

不涉及

key_spec

String

参数解释:

密钥生成算法,查询所有(包含非对称)密钥需要指定参数“ALL”

约束限制:

不涉及

取值范围:

  • AES_256

  • SM4

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

  • ALL

默认取值:

AES_256

enterprise_project_id

String

参数解释:

企业多项目ID

约束限制:

用户未开通企业多项目时,不需要输入该字段,用户开通企业多项目时,查询资源可以输入该字段

取值范围:

取值满足以下任一条件:

  • 取值为“all”

  • 取值为“0”

  • 满足正则匹配:“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”

默认取值:

默认查询租户所有有权限的企业多项目下的资源,此时取值为“all”

keystore_type

String

参数解释:

专属密钥库集群类型

约束限制:

不涉及

取值范围:

  • DEFAULT 表示KMS原有集群

  • DHSM 表示专属加密服务集群

  • CDMS 表示密码卡集群

默认取值:

不涉及

sequence

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

keys

Array of strings

参数解释:

key_id列表

取值范围:

不涉及

key_details

Array of KeyDetails objects

参数解释:

密钥详情列表

取值范围:

不涉及

next_marker

String

参数解释:

获取下一页所需要传递的“marker”值。当“truncated”为“false”时,“next_marker”为空

取值范围:

不涉及

truncated

String

参数解释:

是否还有下一页

取值范围:

  • “true” 表示还有数据。

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

total

Integer

参数解释:

密钥总条数

取值范围:

不涉及

表5 KeyDetails

参数

参数类型

描述

key_id

String

参数解释:

密钥ID

取值范围:

不涉及

domain_id

String

参数解释:

用户域ID

取值范围:

不涉及

key_alias

String

参数解释:

密钥别名

取值范围:

不涉及

realm

String

参数解释:

密钥所属区域

取值范围:

不涉及

key_spec

String

参数解释:

密钥生成算法

取值范围:

  • AES_256

  • SM4

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

key_usage

String

参数解释:

密钥用途

取值范围:

  • ENCRYPT_DECRYPT

  • SIGN_VERIFY

key_description

String

参数解释:

密钥描述

取值范围:

不涉及

creation_date

String

参数解释:

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

取值范围:

不涉及

scheduled_deletion_date

String

参数解释:

密钥计划删除时间,时间戳,即从1970年1月1日至该时间的总秒数

取值范围:

不涉及

key_state

String

参数解释:

密钥状态

取值范围:

  • “1”表示待激活状态

  • “2”表示启用状态

  • “3”表示禁用状态

  • “4”表示计划删除状态

  • “5”表示等待导入状态

default_key_flag

String

参数解释:

默认主密钥标识,默认主密钥标识为1,非默认标识为0

取值范围:

不涉及

key_type

String

参数解释:

密钥类型

取值范围:

不涉及

expiration_time

String

参数解释:

密钥材料失效时间,时间戳,即从1970年1月1日至该时间的总秒数

取值范围:

不涉及

origin

String

参数解释:

密钥来源

取值范围:

  • kms 表示密钥材料由kms生成

  • external 表示密钥材料由外部导入

key_rotation_enabled

String

参数解释:

密钥轮换状态

取值范围:

  • true

  • false

sys_enterprise_project_id

String

参数解释:

企业项目ID

  • 对于开通企业项目的用户,表示资源处于默认企业项目下。

  • 对于未开通企业项目的用户,表示资源未处于企业项目下。

取值范围:

不涉及

keystore_id

String

密钥库ID

keystore_type

String

参数解释:

专属密钥库集群类型

取值范围:

  • DHSM 表示专属加密服务集群

  • CDMS 表示密码卡集群

  • DEFAULT 表示KMS原有集群

请求示例

查询别名以"1"开始的密钥,至多返回2条密钥列表信息。

{
  "limit" : "2",
  "marker" : "1"
}

响应示例

状态码:200

请求已成功

{
  "keys" : [ "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "2e258389-bb1e-4568-a1d5-e1f50adf70ea" ],
  "key_details" : [ {
    "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
    "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
    "key_alias" : "test",
    "realm" : "cn-north-7",
    "key_description" : "key_description",
    "creation_date" : "1502799822000",
    "scheduled_deletion_date" : "",
    "key_spec" : "AES_256",
    "key_usage" : "ENCRYPT_DECRYPT",
    "key_state" : "2",
    "default_key_flag" : "0",
    "key_type" : "1",
    "expiration_time" : "1501578672000",
    "origin" : "kms",
    "key_rotation_enabled" : "true",
    "sys_enterprise_project_id" : "0"
  }, {
    "key_id" : "2e258389-bb1e-4568-a1d5-e1f50adf70ea",
    "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd",
    "key_alias" : "test",
    "realm" : "realm",
    "key_description" : "key_description",
    "creation_date" : "1502799822000",
    "scheduled_deletion_date" : "",
    "key_spec" : "AES_256",
    "key_usage" : "ENCRYPT_DECRYPT",
    "key_state" : "2",
    "default_key_flag" : "0",
    "key_type" : "1",
    "expiration_time" : "1501578672000",
    "origin" : "kms",
    "key_rotation_enabled" : "true",
    "sys_enterprise_project_id" : "0"
  } ],
  "next_marker" : "",
  "truncated" : "false",
  "total" : 2
}

SDK代码示例

SDK代码示例如下。

查询别名以"1"开始的密钥,至多返回2条密钥列表信息。

 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
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 ListKeysSolution {

    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();
        ListKeysRequest request = new ListKeysRequest();
        ListKeysRequestBody body = new ListKeysRequestBody();
        body.withMarker("1");
        body.withLimit("2");
        request.withBody(body);
        try {
            ListKeysResponse response = client.listKeys(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());
        }
    }
}

查询别名以"1"开始的密钥,至多返回2条密钥列表信息。

 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
# 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 = ListKeysRequest()
        request.body = ListKeysRequestBody(
            marker="1",
            limit="2"
        )
        response = client.list_keys(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

查询别名以"1"开始的密钥,至多返回2条密钥列表信息。

 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
54
55
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.ListKeysRequest{}
	markerListKeysRequestBody:= "1"
	limitListKeysRequestBody:= "2"
	request.Body = &model.ListKeysRequestBody{
		Marker: &markerListKeysRequestBody,
		Limit: &limitListKeysRequestBody,
	}
	response, err := client.ListKeys(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档