DescribeAccessKeyDetail - 查询密钥详情--消息队列 RocketMQ版-火山引擎

文档中心

导航

DescribeAccessKeyDetail - 查询密钥详情

最近更新时间：2024.11.18 10:27:32首次发布时间：2023.07.12 16:22:34

调用 DescribeAccessKeyDetail 接口查询指定 RocketMQ 密钥的详细信息。

使用说明

此接口用于查看指定的 RocketMQ 密钥详情，包括默认权限、自定义权限等详细信息。创建密钥后，可以调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表，您可以通过 Description 参数识别出目标密钥，获取其 AccessKey。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAccessKeyDetail	要执行的操作，取值：DescribeAccessKeyDetail。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
AccessKey	String	是	2QdEgrGc97AL1p38Fq13****	RocketMQ 密钥的 AccessKey。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccessKey	String	2QdEgrGc97AL1p38Fq13****	RocketMQ 密钥的 AccessKey。
AllAuthority	String	ALL	RocketMQ 密钥的默认权限。
Description	String	test	RocketMQ 密钥的描述信息。
InstanceId	String	MQ_INST_6921j2pvm7q3_****	实例 ID。
TopicPermissions	Array of Object	[ { "Permission": "ALL", "TopicName": "test" } ]	密钥的自定义权限。若无自定义权限，则显示为 null。

请求示例

POST /?Action=DescribeAccessKeyDetail&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-6921j2pvm7q3_6****",
  "AccessKey": "EdgY6bQMi0nppRY8dxCYP****",
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306201100263B975439B779BC89A6E0",
        "Action": "DescribeAccessKeyDetail",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "AccessKey": "EdgY6bQMi0nppRY8dxCY****",
        "AllAuthority": "ALL",
        "Description": "",
        "InstanceId": "MQ_INST_6921j2pvm7q3_6****",
        "TopicPermissions": [
            {
                "Permission": "ALL",
                "TopicName": "test"
            }
        ]
    }
}

错误码

公共错误码请参见公共错误码文档。