List Cluster Information - ListUKafkaInstance

Overview

List Cluster Information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUKafkaInstance`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project 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
Limit	string	Default is 60	No
Offset	string	Default is 0	No
Filter	string	Whether to filter out deleted nodes, default is 'true'	No
VPCId	string	VPCId	No
SubnetId	string	SubnetId	No
BusinessId	string	BusinessId	No
ClusterInstanceId	string	Cluster ID	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
ClusterSet	string	Information	Yes
TotalCount	string	Total	Yes

Example

Request Example

https://api.surfercloud.com/?Action=ListUKafkaInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=psLewFbM
&Limit=LidCsVTz
&Offset=Rtvvkzbo
&Filter=xaSWuIxd
&VPCId=JiyiuaGj
&SubnetId=lpUAUCTy
&BusinessId=HttFFiEn
&ClusterInstanceId=bfibtMTE

Response Example

{
  "Action": "ListUKafkaInstanceResponse",
  "ClusterSet": [
    {
      "AutoRenew": "Yes",
      "BusinessId": "",
      "ChargeType": "Month",
      "ClusterInstanceId": "ukafka-5xagjz",
      "ClusterInstanceName": "test",
      "CreateTime": 1550476133,
      "ExpireTime": 1551369600,
      "Framework": "Kafka",
      "FrameworkVersion": "1.1.1",
      "NewMessage": "Yes",
      "RedundantCount": 0,
      "Remark": "",
      "RunningTime": 5623,
      "State": "Running",
      "SubnetId": "subnet-ah4q5l",
      "Tag": "Default",
      "UHostCount": 3,
      "VPCId": "uvnet-rgi3ym",
      "Zone": "cn-bj2-02"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

ListUKafkaConsumers ListUKafkaTopics