You need to enable JavaScript to run this app.
导航
ModifyAccessKeyAuthority - 修改AccessKey自定义权限
最近更新时间:2024.11.18 10:27:32首次发布时间:2023.07.12 16:22:34

调用 ModifyAccessKeyAuthority 接口设置 RocketMQ 密钥的自定义权限。

使用说明

如果您需要更为精细的权限粒度管控,推荐通过此接口为密钥添加自定义权限,设置该密钥对于指定 Topic 的权限策略。为密钥添加自定义权限之后,密钥的默认权限仅对自定义权限之外的 Topic 生效。例如某密钥的默认权限为发布,对于指定 Topic 的自定义权限为发布、订阅,则密钥对于此 Topic 实际权限为发布、订阅,对于实例中的其他 Topic 的权限为发布

注意事项

请求频率:该接口请求频率限制为 20 次/秒;单用户请求频率限制为 4 次/秒。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ModifyAccessKeyAuthority

要执行的操作,取值:ModifyAccessKeyAuthority。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

rocketmq-cnoeb5df57dc2857

目标密钥所属实例。

AccessKey
String

C3OmUvlr6*****

待设置自定义权限的 RocketMQ 密钥 AccessKey ID。
创建密钥后,推荐调用 DescribeAccessKeys 接口查看已创建的 RocketMQ 密钥列表,您可以通过 Description 参数识别出目标密钥。

AccessPolicies
Array of Object

[ { "TopicName": "rocketmq123", "Authority": "ALL" }

自定义权限配置,即设置该 AccessKey 对特定 Topic 所拥有的权限。

返回参数

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

请求示例

{
	"InstanceId": "rocketmq-****",
	"AccessKey": "C3OmUvlr6*****",
	"AccessPolicies": [{
		"TopicName": "test",
		"Authority": "PUB"
	}]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024110414171004805215525162FB0E",
    "Action": "ModifyAccessKeyAuthority",
    "Version": "2023-01-01",
    "Service": "RocketMQ",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

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