DescribeAccessKeys - 查询密钥列表--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeAccessKeys - 查询密钥列表

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

调用 DescribeAccessKeys 接口查询 RocketMQ 密钥列表。

使用说明

此接口用于查看指定实例的 RocketMQ 密钥列表，也可用于查看某一密钥的基础信息。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAccessKeys	要执行的操作，取值：DescribeAccessKeys。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
PageNumber	Integer	是	1	列表的页码，最小值为 1。
PageSize	Integer	是	10	列表中每一页的条目数量，取值范围为 1~100。
AccessKey	String	否	2QdEgrGc97AL1p38Fq13****	根据 AccessKey ID 进行精确查询。

返回参数

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

参数	类型	示例值	描述
Total	Integer	1	RocketMQ 密钥总数。
AccessKeysInfo	Array of Object	/	RocketMQ 密钥信息。

请求示例

POST /?Action=DescribeAccessKeys&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****",
  "AccessKey": "2QdEgrGc97AL1p38Fq13****",
  "PageSize": 10,
  "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230508210038363B6D7832B2AB4A8245",
        "Action": "DescribeAccessKeys",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "AccessKeysInfo": [
            {
                "AccessKey": "2QdEgrGc97AL1p38Fq13****",
                "AclConfigJson": "{\"topicPerms\":{\"RMQ_SYS_TRACE_TOPIC\":\"PUB\",\"rocketmq123\":\"PUB|SUB\"},\"groupPerms\":{\"GID_test\":\"PUB|SUB\"}}",
                "Actived": true,
                "AllAuthority": "SUB",
                "CreateTime": 1683545537,
                "Description": "test"
            }
        ],
        "Total": 1
    }
}

错误码

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