更新时间:2024-11-20 GMT+08:00
分享

查询密钥实例

功能介绍

  • 功能介绍:查询密钥实例。通过标签过滤,查询指定用户主密钥的详细信息。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/kms/{resource_instances}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

resource_instances

String

资源实例,固定值为resource_instances

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

limit

String

查询记录数(“action”为“count”时,无需设置此参数),如果“action”为“filter”,默认为“10”。

limit的取值范围为“1-1000”。

offset

String

索引位置。从offset指定的下一条数据开始查询。查询第一页数据时,将查询前一页数据时响应体中的值带入此参数(“action”为“count”时,无需设置此参数)。如果“action”为“filter”,offset默认为“0”。

offset必须为数字,不能为负数。

action

String

操作标识(可设置为“filter”或者“count”)。

  • filter:表示过滤。

  • count:表示查询总条数。

tags

Array of Tag objects

标签列表,key和value键值对的集合。

  • key:表示标签键,一个密钥下最多包含10个key,key不能为空,不能重复,同一个key中value不能重复。key最大长度为36个字符。

  • value:表示标签值。每个值最大长度43个字符,value之间为“与”的关系。

matches

Array of TagItem objects

搜索字段。

  • key为要匹配的字段,例如:resource_name等。

  • value为匹配的值,最大长度为255个字符,不能为空。

sequence

String

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

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

表4 Tag

参数

是否必选

参数类型

描述

key

String

键。

最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

values

Array of strings

标签值集合

表5 TagItem

参数

是否必选

参数类型

描述

key

String

键。

最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

value

String

值。

每个值最大长度43个unicode字符,可以为空字符串。 不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ActionResources objects

资源实例列表,详情请参见resource字段数据结构说明。

total_count

Integer

总记录数。

表7 ActionResources

参数

参数类型

描述

resource_id

String

资源ID。

resource_detail

KeyDetails object

密钥详情。

resource_name

String

资源名称,默认为空字符串。

tags

Array of TagItem objects

标签列表,没有标签,数组默认为空。

表8 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-5]{1}$”,枚举如下:

  • “1”表示待激活状态

  • “2”表示启用状态

  • “3”表示禁用状态

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

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

default_key_flag

String

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

key_type

String

密钥类型。

expiration_time

String

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

origin

String

密钥来源,默认为“kms”,枚举如下:

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

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

key_rotation_enabled

String

密钥轮换状态,默认为“false”,表示关闭密钥轮换功能。

sys_enterprise_project_id

String

企业项目ID,默认为“0”。

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

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

keystore_id

String

密钥库ID

表9 TagItem

参数

参数类型

描述

key

String

键。

最大长度36个unicode字符。 key不能为空。不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

value

String

值。

每个值最大长度43个unicode字符,可以为空字符串。 不能包含非打印字符“ASCII(0-31)”、“*”、“<”、“>”、“\”、“=”。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 401

表12 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表13 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表15 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 404

表16 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表17 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 500

表18 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表19 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 502

表20 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表21 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 504

表22 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表23 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

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代码示例如下。

查询标签键为”key1“,标签值为”value1“或”value2“的密钥实例,起始位置为100,显示条数100。

 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
56
57
58
59
60
61
62
63
64
65
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("<YOUR REGION>"))
                .build();
        ListKmsByTagsRequest request = new ListKmsByTagsRequest();
        request.withResourceInstances("{resource_instances}");
        ListKmsByTagsRequestBody body = new ListKmsByTagsRequestBody();
        List<String> listTagsValues = new ArrayList<>();
        listTagsValues.add("value1");
        listTagsValues.add("value2");
        List<Tag> 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());
        }
    }
}

查询标签键为”key1“,标签值为”value1“或”value2“的密钥实例,起始位置为100,显示条数100。

 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
# 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 = 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)

查询标签键为”key1“,标签值为”value1“或”value2“的密钥实例,起始位置为100,显示条数100。

 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
56
57
58
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kms.NewKmsClient(
        kms.KmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在,资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码

相关文档