docs
api
Kafka(UKafka)
IsUKafkaTopicNameExist

Check if the topic name already exists - IsUKafkaTopicNameExist

Overview

Check if a topic name already exists in the cluster

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is IsUKafkaTopicNameExist.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
ClusterInstanceIdstringCluster IDYes
TopicNamestringTopic name to be checkedYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
IsExiststringDoes it already exist?Yes

Example

Request Example

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

Response Example

{
  "Action": "IsUKafkaTopicNameExistResponse",
  "IsExist": "KDuPjTLR",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved