文档首页/ 消息通知服务 SMN/ API参考/ API/ 密钥操作/ 查询主题下KMS密钥 - ShowKmsKey
更新时间:2025-12-16 GMT+08:00
分享

查询主题下KMS密钥 - ShowKmsKey

功能介绍

查询主题下密钥ID。执行绑定KMS密钥时,用户需要先在IAM处创建名为smn_kms_agency的委托,并将资源操作权限授权给SMN服务。SMN会使用该委托进行查询密钥信息操作。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    smn:topic:getKmsKey

    List

    topic *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    smn:topic:get

URI

GET /v2/{project_id}/notifications/topics/{topic_urn}/kms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

topic_urn

String

Topic的唯一的资源标识。可以通过查看主题列表获取该标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

key_id

String

在DEW服务上创建的用户主密钥对应的密钥ID,具体参考在DEW服务上创建密钥章节。

status

String

密钥的状态字段,为枚举类型。

  • ENABLED状态为密钥启用状态,此时发布的消息均使用该主密钥创建的数据密钥进行加解密。

  • TO_BE_ACTIVATED状态为密钥待激活状态,当密钥未激活时,发布主题消息会返回失败,请前往DEW服务对密钥进行操作。

  • DISABLED状态为密钥禁用状态,当密钥已被禁用时,发布主题消息会返回失败,请前往DEW服务对密钥进行操作。

  • PENDING_DELETION状态为密钥计划删除状态,当密钥已被计划删除时,发布主题消息仍能正常使用该密钥。

  • PENDING_IMPORT状态为密钥计划导入状态,当密钥计划导入时,发布主题消息会返回失败,请前往DEW服务对密钥进行操作。

  • DELETED状态为密钥已删除状态,当密钥已删除后,SMN无法从DEW服务处获取有效的密钥,此时发布主题消息会返回失败,请重新在主题下配置可用的密钥。

id

String

密钥对应的资源ID,该ID由SMN服务生成。

request_id

String

请求的唯一标识ID。

状态码:403

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码:404

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码:500

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

请求成功的示例。

https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:44ef0bd78eb24f02b40614fe85a7d234:topic_05721ee8904211f0871f84a93e8ae4b6/kms

响应示例

状态码:200

请求成功的返回体。

{
  "key_id" : "9a618041-a917-49e0-bb3a-1a90163e97fe",
  "status" : "ENABLED",
  "id" : "d39453da9d6c4026ba0bb3ed1a6efc2d",
  "request_id" : "c16810962f1140da82abcd9e783cf4e2"
}

状态码:403

Forbidden

{
  "request_id" : "c7da9c96193c4017b6d2250477107416",
  "code" : "SMN.0001",
  "message" : "No permission to request resources."
}

状态码:404

Not Found

{
  "request_id" : "135be5478b594200be295f6603f223bd",
  "error_code" : "SMN.00010008",
  "error_msg" : "Topic information is not found."
}

SDK代码示例

SDK代码示例如下。

 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.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;


public class ShowKmsKeySolution {

    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);

        SmnClient client = SmnClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowKmsKeyRequest request = new ShowKmsKeyRequest();
        request.withTopicUrn("{topic_urn}");
        try {
            ShowKmsKeyResponse response = client.showKmsKey(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
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.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 = SmnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowKmsKeyRequest()
        request.topic_urn = "{topic_urn}"
        response = client.show_kms_key(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
 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"
    smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/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 := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowKmsKeyRequest{}
	request.TopicUrn = "{topic_urn}"
	response, err := client.ShowKmsKey(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求成功的返回体。

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档