文档首页/ 消息通知服务 SMN/ API参考/ API/ 密钥操作/ 查询主题下KMS密钥 - ShowKmsKey
更新时间：2025-11-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询主题下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."
}

状态码

状态码

描述

200

请求成功的返回体。

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 密钥操作

相关文档