Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 2.11 KB

is_ukafka_topic_name_exist.md

File metadata and controls

76 lines (46 loc) · 2.11 KB

检查topic名称是否已存在 - IsUKafkaTopicNameExist

简介

检查一个topic名称是否已经在集群中了

使用方法

您可以选择以下方式中的任意一种,发起 API 请求:

定义

公共参数

参数名 类型 描述信息 必填
Action string 对应的 API 指令名称,当前 API 为 IsUKafkaTopicNameExist Yes
PublicKey string 用户公钥,可从 控制台 获取 Yes
Signature string 根据公钥及 API 指令生成的用户签名,参见 签名算法 Yes

请求参数

参数名 类型 描述信息 必填
Region string 地域。 参见 地域和可用区列表 Yes
Zone string 可用区。参见 可用区列表 Yes
ProjectId string 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 No
ClusterInstanceId string 集群ID Yes
TopicName string 待检查的topic名称 Yes

响应字段

字段名 类型 描述信息 必填
RetCode int 返回状态码,为 0 则为成功返回,非 0 为失败 Yes
Action string 操作指令名称 Yes
Message string 返回错误消息,当 RetCode 非 0 时提供详细的描述信息 No
IsExist string 是否已经存在 Yes

示例

请求示例

https://api.ucloud.cn/?Action=IsUKafkaTopicNameExist
&Region=cn-zj
&Zone=cn-zj-01
&ClusterInstanceId=ONbxfJxK
&TopicName=vtsRCkBK

响应示例

{
  "Action": "IsUKafkaTopicNameExistResponse",
  "IsExist": "KDuPjTLR",
  "RetCode": 0
}