调用DescribeAcls查询ACL。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alikafka:ListAcl | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
InstanceId | string | 是 | 实例 ID。 | alikafka_pre-cn-v0h1cng**** |
Username | string | 是 | 用户名。 | test12**** |
AclResourceType | string | 是 | 资源类型。取值:
| Topic |
AclResourceName | string | 是 | 资源名称。
| demo |
AclResourcePatternType | string | 否 | 匹配模式。取值:
| LITERAL |
Host | string | 否 | 来源 IP。 说明
| * |
AclPermissionType | string | 否 | 授权方式。取值:
说明
该参数仅支持 V3 系列(Serverless)实例。
| DENY |
AclOperationType | string | 否 | 操作类型。取值:
| Write |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "operation success.",
"RequestId": "46496E38-881E-4719-A2F3-F3DA6AE****",
"Success": true,
"KafkaAclList": {
"KafkaAclVO": [
{
"AclResourceType": "Topic",
"Host": "****",
"AclOperationType": "Write",
"AclResourceName": "demo",
"AclResourcePatternType": "LITERAL",
"Username": "test12***",
"AclPermissionType": "DENY"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | The %s parameter is required. | 参数%s缺失 |
400 | Acl.DelSasl.Error | Failed to delete the user. Check the request parameters and try again. | 删除用户失败, 请检查请求参数后重试。 |
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 | 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. | 实例获取预期变更时间失败,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-04-02 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2024-02-01 | API 内部配置变更,不影响调用 | 看变更集 | ||||||||||||||
|