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

DescribeTopicAccessPolicies

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

首次发布时间：2023.07.12 16:22:34

我的收藏

调用 DescribeTopicAccessPolicies 接口查看 Topic 的权限列表。

注意事项

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

使用说明

此接口用于查看指定 Topic 的权限列表，即所有 RocketMQ 密钥对于此 Topic 权限。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-cnai1f0c29ca****

实例 ID。

TopicName

String

是

my_topic

Topic 名称。

PageSize

Integer

是

10

查询结果分页展示时，此参数用于表示每页的数据量。取值范围为1~100。

PageNumber

Integer

是

1

查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。

AccessKey

String

否

my_user

用于过滤的RocketMQ 密钥 AccessKey，仅支持精确匹配。
指定 AccessKey 时，只返回指定 AccessKey 对于此 Topic 的权限。

响应参数

参数

参数类型

示例值

说明

AccessPolicies

Array of AccessPolicyObject

/

RocketMQ 密钥对于指定 Topic 的权限。详细信息请参考AccessPolicyObject。

Total

Integer

1

指定 Topic 的权限策略数量。

示例

请求示例

POST /?Action=DescribeTopicAccessPolicies&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-cnai1f0c29ca****",
  "TopicName": "rocketmq123",
  "PageSize": 10,
  "PageNumber": 1
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230508194053A918D0B0E3707B498F8E",
        "Action": "DescribeTopicAccessPolicies",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "AccessPolicies": [
            {
                "AccessKey": "2QdEgrGc97AL1p38Fq13****",
                "Authority": "ALL"
            }
        ],
        "Total": 1
    }
}