You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /
  • 消息队列 RocketMQ版

DescribeAuthKey

最近更新时间：2024.03.06 16:49:21

首次发布时间：2021.08.30 16:57:44

我的收藏

调用 DescribeAuthKey 接口查看指定 RocketMQ 密钥的权限信息。

注意事项

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

使用说明

此接口用于查看指定 RocketMQ 密钥的详细权限信息，包括默认权限和自定义权限。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

必选

MQ_INST_********

实例 ID。

Ak

String

必选

ak****

RocketMQ 密钥中的 AccessKey ID。

响应参数

参数

参数类型

说明

InstanceId

String

实例 ID。

Ak

String

RocketMQ 密钥中的 AccessKey ID。

Description

String

密钥的简单描述。

TopicDefaultPermission

String

密钥的默认权限。

  • DENY：不具备发布或订阅权限。
  • PUB：（默认）仅具备发布权限，不具备订阅权限。
  • SUB：仅具备订阅权限，不具备发布权限。
  • ALL：同时具备发布和订阅权限。

TopicPermissions

Array of TopicPermission

密钥的自定义权限列表，即在哪些 Topic 中分别有怎样的权限。详细说明请参考 TopicPermission。

Status

String

预留字段，默认为空。

示例

请求示例

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

{
  "InstanceId": "MQ_INST_********",
  "Ak": "ak***"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "*********************",
    "Action": "DescribeAuthKey",
    "Version": "2021-04-01",
    "Service": "rocketmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "MQ_INST_********",
    "Ak": "**",
    "Description": "new",
    "TopicDefaultPermission": "DENY",
    "TopicPermissions": [
      {
        "Topic": "new",
        "Permission": "DENY"
      }
    ],
    "Status": ""
  }
}