接口列表
接口列表
Client 共提供 76 个导出接口方法,覆盖集群、集群配置、主题、消费组、用户、权限、任务和 Quota 八类资源。
集群接口
| 方法 |
说明 |
CreateCluster |
创建集群 |
DeleteCluster |
释放集群 |
ListClusters |
查询集群列表 |
GetClusterDetail |
查询集群详情 |
GetClusterDeletion |
查询集群删除详情 |
GetClusterAccessEndpoints |
查询集群接入点 |
GetClusterNodes |
查询集群节点列表 |
GetClusterConfigurations |
查询集群当前配置项 |
IncreaseBrokerCount |
增加节点数量 |
DecreaseBrokerCount |
减少节点数量 |
MigrateClusterAz |
迁移集群可用区 |
UnifyClusterEndpoint |
统一集群访问地址 |
UpdateBrokerNodeType |
变更节点机型 |
ExpandBrokerDiskCapacity |
扩容磁盘容量 |
UpdateAccessConfig |
变更访问与认证配置 |
StartCluster |
启动集群 |
StopCluster |
停止集群 |
ResizeClusterEipBandwidth |
变更公网带宽 |
SwitchClusterEip |
开启或关闭公网访问 |
UpdateStoragePolicy |
变更磁盘阈值策略 |
UpdateKafkaConfig |
应用集群配置版本 |
UpdateSecurityGroup |
变更安全组 |
UpdateMaintenanceDuration |
变更可维护时间 |
SwitchClusterIntranetIp |
开启或关闭产品间转储 |
GetClusterCurrentController |
查询当前 Controller |
GetClusterHistoryController |
查询历史 Controller |
RestartCluster |
重启集群 |
RestartBroker |
重启指定 Broker |
SwitchClusterAdvertisedIp |
开启或关闭跨 VPC 访问 |
SwitchClusterDomain |
开启或关闭集群域名 |
GetZkPassword |
查询 ZooKeeper 访问凭证 |
集群配置接口
| 方法 |
说明 |
CreateClusterConfig |
创建集群配置 |
ListClusterConfigs |
查询集群配置列表 |
DeleteClusterConfig |
删除集群配置 |
GetClusterConfig |
查询集群配置详情 |
CreateClusterConfigRevision |
新增集群配置版本 |
ListClusterConfigRevisions |
查询集群配置版本列表 |
GetClusterConfigRevision |
查询集群配置版本详情 |
主题接口
| 方法 |
说明 |
CreateTopic |
创建主题 |
DeleteTopic |
删除主题 |
ListTopic |
查询主题列表 |
GetTopicDetail |
查询主题详情 |
UpdateTopic |
变更主题分区数或配置 |
ListTopicPartitions |
查询主题分区列表 |
GetTopicPartitionDetail |
查询主题分区详情 |
GetTopicPartitionOverview |
查询主题分区概览 |
ListSubscribedGroups |
查询订阅主题的消费组 |
GetSubscribedGroupDetail |
查询主题订阅详情 |
GetSubscribedGroupOverview |
查询主题订阅关系概览 |
ListTopicConfigOptions |
查询主题支持的参数信息 |
SendTopicMessage |
向主题发送消息 |
QueryTopicMessagesByStartTime |
按起始时间查询消息 |
QueryTopicMessagesByStartOffset |
按起始位点查询消息 |
消费组接口
| 方法 |
说明 |
ListConsumerGroup |
查询消费组列表 |
DeleteConsumerGroup |
删除消费组 |
ResetConsumerGroup |
重置消费组位点 |
ListSubscribedTopics |
查询消费组订阅的主题列表 |
GetSubscribedTopicOverview |
查询消费组订阅关系概览 |
用户与 ACL 接口
| 方法 |
说明 |
CreateUser |
创建用户 |
DeleteUser |
删除用户 |
ResetUserPassword |
重置用户密码 |
ListUsers |
查询用户列表 |
CreateAcl |
创建权限 |
DeleteAcl |
删除权限 |
ListAcls |
查询权限列表 |
任务接口
| 方法 |
说明 |
ListJobs |
查询作业列表 |
GetJob |
查询作业详情 |
GetOperation |
查询操作详情 |
StartJob |
启动作业 |
CancelJob |
取消作业 |
SuspendJob |
暂停作业 |
ResumeJob |
恢复作业 |
Quota 接口
| 方法 |
说明 |
ListQuotas |
查询 Quota 列表 |
CreateQuota |
创建 Quota |
UpdateQuota |
更新 Quota |
DeleteQuota |
删除 Quota |