调用GetQuotaTip获取Topic和分区的使用配额_云消息队列 Kafka 版(Kafka)-阿里云帮助中心

获取Topic和分区的使用配额。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
InstanceId	string	是	实例 ID。	alikafka_pre-cn-i7m2wpm5****

返回参数

名称	类型	描述	示例值
	object
Code	integer	状态码。返回 200 代表成功。	200
Message	string	附加信息，典型应用场景是对失败调用进行简述，方便调用方定位问题	operation success.
RequestId	string	请求 ID。	0178A3A7-E87B-5E50-A16F-3E62F534****
Success	boolean	请求是否成功。	True
QuotaData	object	quota 配额。
TopicNumOfBuy	integer	Topic 购买量。	50
TopicQuota	integer	Topic 配额。	50
TopicLeft	integer	Topic 余量。	20
TopicUsed	integer	Topic 使用量。	30
PartitionNumOfBuy	integer	分区购买量。	100
PartitionLeft	integer	分区余量。	1050
PartitionUsed	integer	分区使用量。	50
GroupLeft	integer	Group 余量。	50
GroupUsed	integer	Group 用量。	50
IsPartitionBuy	integer	分区购买方式区分，取值如下： 0：代表实例用 topic 模型购买； 1：代表分区模型购买。	1
PartitionQuota	integer	分区配额。	1100

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "0178A3A7-E87B-5E50-A16F-3E62F534****",
  "Success": true,
  "QuotaData": {
    "TopicNumOfBuy": 50,
    "TopicQuota": 50,
    "TopicLeft": 20,
    "TopicUsed": 30,
    "PartitionNumOfBuy": 100,
    "PartitionLeft": 1050,
    "PartitionUsed": 50,
    "GroupLeft": 50,
    "GroupUsed": 50,
    "IsPartitionBuy": 1,
    "PartitionQuota": 1100
  }
}

错误码

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