ModifyAccessKeyAllAuthority - 修改AccessKey默认权限--消息队列 RocketMQ版-火山引擎

文档中心

导航

ModifyAccessKeyAllAuthority - 修改AccessKey默认权限

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

调用 ModifyAccessKeyAllAuthority 接口修改 RocketMQ 密钥的默认权限。

使用说明

此接口用于修改指定 RocketMQ 密钥的默认权限，此权限默认对实例中所有的 Topic 生效。如果您需要更为精细的权限粒度管控，也可以通过 ModifyAccessKeyAuthority 接口为密钥添加自定义权限，设置该密钥对于指定 Topic 的权限策略。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyAccessKeyAllAuthority	要执行的操作，取值：ModifyAccessKeyAllAuthority。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
AccessKey	String	是	2QdEgrGc97AL1p38Fq13****	待修改默认权限的 RocketMQ 密钥 AccessKey ID。创建密钥后，推荐调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表，您可以通过 Description 参数识别出目标密钥。
AllAuthority	String	是	SUB	RocketMQ 密钥的默认权限。 ALL：拥有发布和订阅权限 PUB：拥有发布权限 SUB：拥有订阅权限 DENY：不具备发布或订阅权限

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyAccessKeyAllAuthority&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****",
  "AllAuthority": "SUB"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305082056151B32BBF1491C934B2382",
        "Action": "ModifyAccessKeyAllAuthority",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {}
}

错误码

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