# 查询密钥实例 - ListKmsByTags #### 功能介绍 - 功能介绍：查询密钥实例。通过标签过滤，查询指定用户主密钥的详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | kms:cmk:listKeysByTag | List | KeyId \* | - | kms:cmkTag:listInstance | - | #### URI POST /v1.0/{project_id}/kms/{resource_instances}/action 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于唯一标识用户项目。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取，以IAM服务接口返回值为准 **约束限制：** 不涉及 **取值范围：** 字符长度32-32。 **默认取值：** 不涉及 | | resource_instances | 是 | String | **参数解释：** 资源实例，固定值为resource_instances **约束限制：** 不涉及 **取值范围：** 固定值为resource_instances **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值），以IAM服务查询用户Token接口为准 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | String | **参数解释：** 查询返回密钥实例列表时，用于限制每页返回的记录数量 **约束限制：** - "action"为"count"时，无需设置此参数 - limit必须为整数 **取值范围：** 1\~1000 **默认取值：** "action"为"filter"时，默认为"10" | | offset | 否 | String | **参数解释：** 索引位置，用于分页查询密钥实例列表时指定起始位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数 **约束限制：** - offset必须为整数 - "action"为"count"时，无需设置此参数 **取值范围：** 0\~1000 **默认取值：** 如果"action"为"filter"，offset默认为"0" | | action | 否 | String | **参数解释：** 操作标识，指定查询密钥实例的操作类型，支持过滤查询和计数查询两种操作 **约束限制：** 不涉及 **取值范围：** - filter：表示过滤。 - count：表示查询总条数。 **默认取值：** 不涉及 | | tags | 否 | Array of [Tag] objects | **参数解释：** 标签列表，key和value键值对的集合。用于按标签过滤查询密钥实例 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | matches | 否 | Array of [TagItem] objects | **参数解释：** 搜索字段，用于按指定字段匹配查询密钥实例 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sequence | 否 | String | **参数解释：** 请求消息序列号，36字节序列号，例如：919c82d4-8046-4722-9094-35c3c6524cff **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4Tag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释：** 标签键 **约束限制：** - 不能为空 - 最大长度36个unicode字符 - 不能包含非打印字符"ASCII(0-31)"、"\*"、"\<"、"\>"、"\\"、"=" **取值范围：** **默认取值：** 不涉及 | | values | 否 | Array of strings | **参数解释：** 标签值列表，每个元素为一个标签值字符串 **约束限制：** - 不能为空 - 最大长度43个unicode字符 - 不能包含非打印字符"ASCII(0-31)"、"\*"、"\<"、"\>"、"\\"、"=" **取值范围：** **默认取值：** 不涉及 | 表5TagItem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 标签键 **约束限制：** - 最大长度36个unicode字符 - 不能包含非打印字符"ASCII(0-31)"、"\*"、"\<"、"\>"、"\\"、"=" - 不能为空 **取值范围：** 不涉及 **默认取值：** 不涉及 | | value | 否 | String | **参数解释：** 标签值 **约束限制：** - 最大长度43个unicode字符 - 不能包含非打印字符"ASCII(0-31)"、"\*"、"\<"、"\>"、"\\"、"=" - 不能为空 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resources | Array of [ActionResources] objects | **参数解释：** 资源实例列表 **取值范围：** 不涉及 | | total_count | Integer | **参数解释：** 记录总数 **取值范围：** 不涉及 | 表7ActionResources | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_id | String | **参数解释：** 资源ID **取值范围：** 不涉及 | | resource_detail | [KeyDetails] object | 密钥详情。 | | resource_name | String | **参数解释：** 资源名称 **取值范围：** 不涉及 | | tags | Array of [TagItem] objects | **参数解释：** 标签列表，没有标签，数组默认为空 **取值范围：** 不涉及 | 表8KeyDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_id | String | **参数解释：** 密钥ID **取值范围：** 不涉及 | | domain_id | String | **参数解释：** 用户域ID **取值范围：** 不涉及 | | key_alias | String | **参数解释：** 密钥别名 **取值范围：** 不涉及 | | realm | String | **参数解释：** 密钥所属区域 **取值范围：** 不涉及 | | key_spec | String | **参数解释：** 密钥生成算法 **取值范围：** - AES_256 表示AES 256位对称加密算法 - SM4 表示国密SM4对称加密算法 - RSA_2048 表示RSA 2048位非对称加密算法 - RSA_3072 表示RSA 3072位非对称加密算法 - RSA_4096 表示RSA 4096位非对称加密算法 - EC_P256 表示256位椭圆曲线加密算法 - EC_P384 表示384位椭圆曲线加密算法 - SM2 表示国密SM2非对称加密算法 | | key_usage | String | **参数解释：** 密钥用途 **取值范围：** - ENCRYPT_DECRYPT 表示加解密 - SIGN_VERIFY 表示签名验签 | | key_description | String | **参数解释：** 密钥描述 **取值范围：** 不涉及 | | creation_date | String | **参数解释：** 密钥创建时间，时间戳，即从1970年1月1日至该时间的总毫秒数，例如1502799822000 **取值范围：** 不涉及 | | scheduled_deletion_date | String | **参数解释：** 密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总毫秒数，例如1502799822000 **取值范围：** 不涉及 | | key_state | String | **参数解释：** 密钥状态 **取值范围：** - "1"表示待激活状态 - "2"表示启用状态 - "3"表示禁用状态 - "4"表示计划删除状态 - "5"表示等待导入状态 | | default_key_flag | String | **参数解释：** 默认主密钥标识 **取值范围：** - 0：非默认主密钥 - 1：默认主密钥 | | key_type | String | **参数解释：** 密钥类型 **取值范围：** 不涉及 | | expiration_time | String | **参数解释：** 密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总毫秒数，例如1502799822000 **取值范围：** 不涉及 | | 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原有集群 | 表9TagItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键 **取值范围：** 不涉及 | | value | String | **参数解释：** 标签值 **取值范围：** 不涉及 | #### 请求示例 查询标签键为"key1"，标签值为"value1"或"value2"的密钥实例，起始位置为100，显示条数100。 ``` { "offset" : "100", "limit" : "100", "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] } ``` #### 响应示例 **状态码：200** ``` { "resources" : [ { "resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "resource_detail" : { "key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc", "key_alias" : "tagTest_xmdmi", "key_description" : "123", "creation_date" : "1521449277000", "scheduled_deletion_date" : "", "key_state" : "2", "default_key_flag" : "0", "key_type" : "1", "key_rotation_enabled" : "false", "expiration_time" : "", "origin" : "kms", "sys_enterprise_project_id" : "0", "realm" : "test" }, "resource_name" : "tagTest_xmdmi", "tags" : [ { "key" : "key", "value" : "testValue!" }, { "key" : "haha", "value" : "testValue" } ] } ], "total_count" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询标签键为"key1"，标签值为"value1"或"value2"的密钥实例，起始位置为100，显示条数100。 ``` 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.*; import java.util.List; import java.util.ArrayList; public class ListKmsByTagsSolution { 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("")) .build(); ListKmsByTagsRequest request = new ListKmsByTagsRequest(); request.withResourceInstances("{resource_instances}"); ListKmsByTagsRequestBody body = new ListKmsByTagsRequestBody(); List listTagsValues = new ArrayList<>(); listTagsValues.add("value1"); listTagsValues.add("value2"); List listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("key1") .withValues(listTagsValues) ); body.withTags(listbodyTags); body.withAction("filter"); body.withOffset("100"); body.withLimit("100"); request.withBody(body); try { ListKmsByTagsResponse response = client.listKmsByTags(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()); } } } ``` - [Python] 查询标签键为"key1"，标签值为"value1"或"value2"的密钥实例，起始位置为100，显示条数100。 ``` # 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("")) \ .build() try: request = ListKmsByTagsRequest() request.resource_instances = "{resource_instances}" listValuesTags = [ "value1", "value2" ] listTagsbody = [ Tag( key="key1", values=listValuesTags ) ] request.body = ListKmsByTagsRequestBody( tags=listTagsbody, action="filter", offset="100", limit="100" ) response = client.list_kms_by_tags(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询标签键为"key1"，标签值为"value1"或"value2"的密钥实例，起始位置为100，显示条数100。 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kms.NewKmsClient(hcClient) request := &model.ListKmsByTagsRequest{} request.ResourceInstances = "{resource_instances}" var listValuesTags = []string{ "value1", "value2", } keyTags:= "key1" var listTagsbody = []model.Tag{ { Key: &keyTags, Values: &listValuesTags, }, } actionListKmsByTagsRequestBody:= "filter" offsetListKmsByTagsRequestBody:= "100" limitListKmsByTagsRequestBody:= "100" request.Body = &model.ListKmsByTagsRequestBody{ Tags: &listTagsbody, Action: &actionListKmsByTagsRequestBody, Offset: &offsetListKmsByTagsRequestBody, Limit: &limitListKmsByTagsRequestBody, } response, err := client.ListKmsByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/KMS/sdk?api=ListKmsByTags)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。