查询密钥信息
功能介绍
-
功能介绍:查询密钥详细信息。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/kms/describe-key
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。 |
sequence |
否 |
String |
请求消息序列号,36字节序列号。 例如:919c82d4-8046-4722-9094-35c3c6524cff |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
key_info |
KeyDetails object |
密钥详情。 |
参数 |
参数类型 |
描述 |
---|---|---|
key_id |
String |
密钥ID。 |
domain_id |
String |
用户域ID。 |
key_alias |
String |
密钥别名。 |
realm |
String |
密钥区域。 |
key_spec |
String |
密钥生成算法。
|
key_usage |
String |
密钥用途。
|
key_description |
String |
密钥描述。 |
creation_date |
String |
密钥创建时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
scheduled_deletion_date |
String |
密钥计划删除时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
key_state |
String |
密钥状态,满足正则匹配“^[1-5]{1}$”,枚举如下:
|
default_key_flag |
String |
默认主密钥标识,默认主密钥标识为1,非默认标识为0。 |
key_type |
String |
密钥类型。 |
expiration_time |
String |
密钥材料失效时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
origin |
String |
密钥来源,默认为“kms”,枚举如下:
|
key_rotation_enabled |
String |
密钥轮换状态,默认为“false”,表示关闭密钥轮换功能。 |
sys_enterprise_project_id |
String |
企业项目ID,默认为“0”。
|
keystore_id |
String |
密钥库ID |
状态码: 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 |
错误请求返回的错误信息 |
请求示例
查询ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"密钥的详细信息。
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f" }
响应示例
状态码: 200
请求已成功
{ "key_info" : { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "test", "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" : "false", "sys_enterprise_project_id" : "0" } }
SDK代码示例
SDK代码示例如下。
查询ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"密钥的详细信息。
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 |
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 ListKeyDetailSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); KmsClient client = KmsClient.newBuilder() .withCredential(auth) .withRegion(KmsRegion.valueOf("<YOUR REGION>")) .build(); ListKeyDetailRequest request = new ListKeyDetailRequest(); OperateKeyRequestBody body = new OperateKeyRequestBody(); body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f"); request.withBody(body); try { ListKeyDetailResponse response = client.listKeyDetail(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()); } } } |
查询ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"密钥的详细信息。
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = KmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListKeyDetailRequest() request.body = OperateKeyRequestBody( key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f" ) response = client.list_key_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"密钥的详细信息。
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := kms.NewKmsClient( kms.KmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListKeyDetailRequest{} request.Body = &model.OperateKeyRequestBody{ KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f", } response, err := client.ListKeyDetail(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 |
网关超时 |
错误码
请参见错误码。