Get Kafka Consumer Group Information - DescribeUKafkaConsumer

Overview

Get Kafka Consumer Group Information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUKafkaConsumer`.	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	Yes
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
ClusterInstanceId	string	Kafka Cluster ID	Yes
ConsumerGroup	string	Consumer Group Name	Yes
Type	string	Consumer Group Type (same as the type value returned by the Consumer Group List)	Yes

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
GroupName	string	Consumer Group Name	No
Type	string	Consumer Group Type	No
Topics	string	Information on the topic subscribed by the consumer group	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUKafkaConsumer
&Region=cn-bj2
&Zone=cn-bj2-02
&ProjectId=KQFUAJET
&ClusterInstanceId=ukafka-asje3q
&ConsumerGroup=group1
&Type=ZK

Response Example

{
  "Action": "DescribeUKafkaConsumerResponse",
  "GroupName": "group1",
  "RetCode": 0,
  "Topics": {
    "bar": {
      "LagPer": 0.2941239495259584,
      "LastUpdateTime": 1538194238000,
      "PartitionAssignedPer": 0,
      "Partitions": {
        "0": {
          "Consumer": "",
          "CurrentOffset": 2009411,
          "Lag": 837280,
          "LogEndOffset": 2846691
        }
      },
      "TotalLag": 837280
    },
    "foo": {
      "LastUpdateTime": 1538194238000,
      "LogPer": 0.000013680915448685166,
      "PartitionAssignedPer": 1,
      "Partitions": {
        "0": {
          "Consumer": "group1_ukafka-asje3q-kafka2-1538033810949-626a2e06-0",
          "CurrentOffset": 1534824,
          "Lag": 43,
          "LogEndOffset": 1534867
        },
        "1": {
          "Consumer": "group1_ukafka-asje3q-kafka2-1538101885995-a9d3def3-0",
          "CurrentOffset": 1534519,
          "Lag": 10,
          "LogEndOffset": 1534529
        },
        "2": {
          "Consumer": "group1_ukafka-asje3q-kafka2-1538101889777-b0fb1091-0",
          "CurrentOffset": 1535549,
          "Lag": 10,
          "LogEndOffset": 1535559
        }
      },
      "TotalLag": 63
    }
  },
  "Type": "ZK"
}

Index DescribeUKafkaInstance