DescribeSecretKey - 查看AccessKey的SecretKey--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeSecretKey - 查看AccessKey的SecretKey

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

调用 DescribeSecretKey 接口查看指定 RocketMQ 密钥的 AccessKey Secret。

使用说明

创建密钥并设置密钥权限之后，还需要查看详细的密钥信息，用于代码的鉴权参数配置。您可以调用此接口，根据 AccessKey ID 查看对应的 AccessKey Secret。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeSecretKey	要执行的操作，取值：DescribeSecretKey。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
AccessKey	String	是	2QdEgrGc97AL1p38Fq13***	RocketMQ 密钥的 AccessKey ID。创建密钥后，推荐调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表，您可以通过 Description 参数识别出目标密钥。

返回参数

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

参数	类型	示例值	描述
AccessKey	String	2QdEgrGc97AL1p38Fq13****	RocketMQ 密钥的 AccessKey ID。
SecretKey	String	lscGZbtckrGOSvNydN8w****	RocketMQ 密钥的 AccessKey Secret。

请求示例

POST /?Action=DescribeSecretKey&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****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305082054102D813727AF9C4B472E18",
        "Action": "DescribeSecretKey",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "AccessKey": "2QdEgrGc97AL1p38Fq13****",
        "SecretKey": "lscGZbtckrGOSvNydN8w****"
    }
}

错误码

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