调用CreateAcl创建ACL_云消息队列 Kafka 版(Kafka)-阿里云帮助中心

调用CreateAcl创建ACL。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alikafka:CreateAcl	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
InstanceId	string	是	实例 ID。	alikafka_pre-cn-v0h1cng0****
Username	string	是	用户名。支持使用星号（*）表示所有用户名。	test***
AclResourceType	string	是	资源类型。取值： Topic：消息主题。 Group：消费组。 Cluster：实例。 TransactionalId：事务 ID。	Group
AclResourceName	string	是	资源名称。资源的名称，可以是 Topic 名称、Group ID、集群名称或事务 ID。支持使用星号（*）表示该类型的资源。	X****
AclResourcePatternType	string	是	匹配模式。取值： LITERAL：完全匹配 PREFIXED：前缀匹配	LITERAL
AclOperationType	string	是	操作类型。取值： Write：写入 Read：读取 Describe：读取 TransactionalId IdempotentWrite：幂等写 Cluster IDEMPOTENT_WRITE：幂等写 Cluster，仅 V3 系列实例可用。 DESCRIBE_CONFIGS：查询配置，仅 V3 系列实例可用。	Read
AclOperationTypes	string	否	批量授权操作类型。多个操作以 , 分割。取值： Write：读取 Read：写入 Describe：读取 TransactionalId IdempotentWrite：幂等写 Cluster IDEMPOTENT_WRITE：幂等写 Cluster，仅 V3 系列实例可用。 DESCRIBE_CONFIGS：查询配置，仅 V3 系列实例可用。说明该参数仅支持 V3 系列（Serverless）实例。	Write,Read
AclPermissionType	string	否	授权方式。取值： DENY：拒绝。 ALLOW：允许。说明该参数仅支持 V3 系列（Serverless）实例。	DENY
Host	string	否	来源 IP。说明仅支持具体的 IP 地址或者设置 * （IP 全开），不支持设置 IP 网段。该参数仅支持 V3 系列（Serverless）实例。	*

返回参数

名称	类型	描述	示例值
	object
Code	integer	状态码。返回 200 代表成功。	200
Message	string	返回信息。	operation success
RequestId	string	请求 ID。	56729737-C428-4E1B-AC68-7A8C2D5****
Success	boolean	调用是否成功。	true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success",
  "RequestId": "56729737-C428-4E1B-AC68-7A8C2D5****",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Acl.AddSasl.Error	Failed to add a user. Please refer to the document and try again. If in doubt, submit a work order.	新增用户失败，请参考文档后重试，如有疑问，请提交工单。
400	BIZ_SASL_USER_NOT_EXIST	%s. Please check and try again later.	指定用户不存在
400	BIZ_SASL_USER_NUM_EXCEED	%s. Please check and try again later.	SASL用户数超限
400	Acl.Disable.Error	The Acl function is disabled. Enable it by referring to the documentation and try again.	Acl 功能未开启，请参考文档开启后重试。
400	Acl.DuplicatedAuth.Error	The authorization has already been granted, please do not repeat the authorization.	已经授权过了，请不要重复授权。
400	BIZ_ACL_NOT_ENABLED	%s. Please check and try again later.	未开启ACL功能
400	BIZ_CAN_NOT_ENABLE_ACL	%s. Please check and try again later.	无法开启ACL，请确认ACL开启条件
400	BIZ_UPDATE_ACL_FAILED	%s. Please check and try again later.	修改ACL失败，请稍后再试
400	Instance.CaclulateChange.time	Example Failed to obtain the expected change time. Please try again later.	实例获取预期变更时间失败，请稍后重试。
400	Instance.StatusNotRunning	The instance is not running and cannot operate this function. Please try again later.	实例不是运行中状态，无法操作该功能，请稍后重试。
400	InvalidParameter	The %s parameter is invalid.	参数%s校验不通过
400	MissingParameter	The %s parameter is required.	参数%s缺失
400	Acl.DelSasl.Error	Failed to delete the user. Check the request parameters and try again.	删除用户失败, 请检查请求参数后重试。
404	Instance.NotFound	No instance found for the %s parameter.	实例不存在

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2024-04-02

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：400
	新增错误码：404
入参	OpenAPI 入参发生变更。
	新增入参：AclOperationTypes
	新增入参：AclPermissionType
	新增入参：Host

2024-01-30

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。