tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TDMQ for CKafka
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-11-27 17:59:02
    Download PDF

      Acl

      ACL object entity

      Used by actions: DescribeACL.

      Name Type Description
      ResourceType Integer ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only TOPIC is available,
      ResourceName String Resource name, which is related to resourceType. For example, if resourceType is TOPIC, this field indicates the topic name; if resourceType is GROUP, this field indicates the group name
      Principal String User list. The default value is User:*, which means that any user can access. The current user can only be one included in the user list
      Note: this field may return null, indicating that no valid values can be obtained.
      Host String The default value is *, which means that any host can access. Currently, CKafka does not support the host as *, but the future product based on the open-source Kafka will directly support this
      Note: this field may return null, indicating that no valid values can be obtained.
      Operation Integer ACL operation mode. 0: UNKNOWN, 1: ANY, 2: ALL, 3: READ, 4: WRITE, 5: CREATE, 6: DELETE, 7: ALTER, 8: DESCRIBE, 9: CLUSTER_ACTION, 10: DESCRIBE_CONFIGS, 11: ALTER_CONFIGS, 12: IDEMPOTEN_WRITE
      PermissionType Integer Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW

      AclResponse

      Set of returned ACL results

      Used by actions: DescribeACL.

      Name Type Description
      TotalCount Integer Number of eligible data entries
      AclList Array of Acl ACL list
      Note: this field may return null, indicating that no valid values can be obtained.

      AclRule

      Output parameters of ACL rule list APIs

      Used by actions: DescribeAclRule, DescribeTopicAttributes.

      Name Type Description
      RuleName String ACL rule name.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      InstanceId String Instance ID.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      PatternType String Matching type. Currently, only prefix match is supported. Enumerated value list: PREFIXED
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Pattern String Prefix value for prefix match.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      ResourceType String ACL resource type. Only “Topic” is supported. Enumerated value list: Topic.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      AclList String ACL information contained in the rule.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      CreateTimeStamp String Creation time of the rule.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      IsApplied Integer A parameter used to specify whether the preset ACL rule is applied to new topics.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      UpdateTimeStamp String Rule update time.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Comment String Remarks of the rule.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      TopicName String One of the corresponding topic names that is displayed.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      TopicCount Integer The number of topics that apply this ACL rule.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      PatternTypeTitle String Name of rule type.
      Note: this field may return null, indicating that no valid values can be obtained.

      AclRuleInfo

      Four pieces of information of ACL rules: source IP address, destination IP address, source port, and destination port

      Used by actions: BatchCreateAcl, CreateAclRule.

      Name Type Required Description
      Operation String Yes ACL operation types. Enumerated values: All (all operations), Read (read), Write (write).
      PermissionType String Yes Permission types: Deny, Allow.
      Host String Yes The default value is *, which means that any host can access the topic. CKafka currently does not support specifying a host value of * or an IP range.
      Principal String Yes The list of users allowed to access the topic. Default value: User:*, which means all users. The current user must be in the user list. Add the prefix User: before the user name (User:A, for example).

      AclRuleResp

      Results returned by the AclRuleList API

      Used by actions: DescribeAclRule.

      Name Type Description
      TotalCount Integer Total number of data entries
      AclRuleList Array of AclRule ACL rule list
      Note: This field may return null, indicating that no valid values can be obtained.

      AppIdResponse

      AppId query result

      Used by actions: DescribeAppInfo.

      Name Type Description
      TotalCount Integer Number of eligible AppId
      AppIdList Array of Integer List of eligible AppId
      Note: this field may return null, indicating that no valid values can be obtained.

      Assignment

      Stores the information of partition assigned to this consumer

      Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.

      Name Type Description
      Version Integer Assignment version information
      Topics Array of GroupInfoTopics Topic information list
      Note: this field may return null, indicating that no valid values can be obtained.

      BatchContent

      Message content that can be sent in batches

      Used by actions: SendMessage.

      Name Type Required Description
      Body String Yes Message body that is sent.
      Key String No Message sending key name.

      BatchModifyTopicInfo

      Topic parameters that can be modified in batches

      Used by actions: BatchModifyTopicAttributes.

      Name Type Required Description
      TopicName String Yes Topic name.
      PartitionNum Integer No The number of partitions.
      Note String No Remarks.
      ReplicaNum Integer No Number of replicas.
      CleanUpPolicy String No Message deletion policy. Valid values: delete, compact.
      MinInsyncReplicas Integer No The minimum number of replicas specified by min.insync.replicas when the producer sets request.required.acks to -1.
      UncleanLeaderElectionEnable Boolean No Whether to allow a non-ISR replica to be the leader.
      RetentionMs Integer No Message retention period in topic dimension in milliseconds. Value range: 1 minute to 90 days.
      RetentionBytes Integer No Message retention size in topic dimension. Value range: 1 MB - 1024 GB.
      SegmentMs Integer No Segment rolling duration in milliseconds. Value range: 1-90 days.
      MaxMessageBytes Integer No Message size per batch. Value range: 1 KB - 12 MB.

      BatchModifyTopicResultDTO

      Results of the batch modified topic attributes

      Used by actions: BatchModifyTopicAttributes.

      Name Type Description
      InstanceId String Instance ID.
      Note: this field may return null, indicating that no valid values can be obtained.
      TopicName String Topic name.
      Note: this field may return null, indicating that no valid values can be obtained.
      ReturnCode String Status code.
      Note: this field may return null, indicating that no valid values can be obtained.
      Message String Message status.

      ClusterInfo

      Cluster information entity

      Used by actions: DescribeCkafkaZone.

      Name Type Description
      ClusterId Integer Cluster ID
      ClusterName String Cluster name
      MaxDiskSize Integer The cluster’s maximum disk capacity in GB
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      MaxBandWidth Integer The cluster’s maximum bandwidth in MB/s
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      AvailableDiskSize Integer The cluster’s available disk capacity in GB
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      AvailableBandWidth Integer The cluster’s available bandwidth in MB/s
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      ZoneId Integer The AZ where the cluster resides
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      ZoneIds Array of Integer The AZ where the cluster nodes reside. If the cluster is a multi-AZ cluster, this field means multiple AZs where the cluster nodes reside.
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      Config

      Advanced configuration object

      Used by actions: DescribeTopicAttributes, DescribeTopicDetail.

      Name Type Description
      Retention Integer Message retention period
      Note: this field may return null, indicating that no valid values can be obtained.
      MinInsyncReplicas Integer Minimum number of sync replications
      Note: this field may return null, indicating that no valid values can be obtained.
      CleanUpPolicy String Log cleanup mode. Default value: delete.
      delete: logs will be deleted by save time; compact: logs will be compressed by key; compact, delete: logs will be compressed by key and deleted by save time.
      Note: this field may return null, indicating that no valid values can be obtained.
      SegmentMs Integer Segment rolling duration
      Note: this field may return null, indicating that no valid values can be obtained.
      UncleanLeaderElectionEnable Integer 0: false, 1: true.
      Note: this field may return null, indicating that no valid values can be obtained.
      SegmentBytes Integer Number of bytes for segment rolling
      Note: this field may return null, indicating that no valid values can be obtained.
      MaxMessageBytes Integer Maximum number of message bytes
      Note: this field may return null, indicating that no valid values can be obtained.
      RetentionBytes Integer Message retention file size.
      Note: this field may return null, indicating that no valid values can be obtained.

      ConsumerGroup

      User group entity

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      ConsumerGroupName String User group name
      SubscribedInfo Array of SubscribedInfo Subscribed message entity

      ConsumerGroupResponse

      Returned consumer group result entity

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      TotalCount Integer Number of eligible consumer groups
      TopicList Array of ConsumerGroupTopic Topic list
      Note: this field may return null, indicating that no valid values can be obtained.
      GroupList Array of ConsumerGroup Consumer group list
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalPartition Integer Total number of partitions
      Note: this field may return null, indicating that no valid values can be obtained.
      PartitionListForMonitor Array of Partition List of monitored partitions
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalTopic Integer Total number of topics
      Note: this field may return null, indicating that no valid values can be obtained.
      TopicListForMonitor Array of ConsumerGroupTopic List of monitored topics
      Note: this field may return null, indicating that no valid values can be obtained.
      GroupListForMonitor Array of Group List of monitored groups
      Note: this field may return null, indicating that no valid values can be obtained.

      ConsumerGroupTopic

      Consumer group topic object

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      TopicId String Topic ID
      TopicName String Topic name

      ConsumerRecord

      Message record

      Used by actions: FetchMessageByOffset, FetchMessageListByOffset.

      Name Type Description
      Topic String Topic name
      Partition Integer Partition ID
      Offset Integer Offset
      Key String Message key
      Note: this field may return null, indicating that no valid values can be obtained.
      Value String Message value
      Note: this field may return null, indicating that no valid values can be obtained.
      Timestamp Integer Message timestamp
      Note: this field may return null, indicating that no valid values can be obtained.
      Headers String Message headers
      Note: This field may return null, indicating that no valid values can be obtained.

      CreateInstancePostData

      Data structure returned by the pay-as-you-go instance creation API

      Used by actions: CreatePostPaidInstance.

      Name Type Description
      FlowId Integer This parameter has a fixed value of 0 returned by CreateInstancePre. It is only used for backend data alignment and cannot be used as the query condition for CheckTaskStatus.
      Note: This field may return null, indicating that no valid values can be obtained.
      DealNames Array of String List of order IDs Note: This field may return null, indicating that no valid values can be obtained.
      InstanceId String Instance ID. When multiple instances are purchased, the ID of the first one is returned by default . Note: This field may return null, indicating that no valid values can be obtained.
      DealNameInstanceIdMapping Array of DealInstanceDTO Mapping between orders and the purchased instances. Note: This field may return null, indicating that no valid values can be obtained.

      CreateInstancePostResp

      Data structure returned by pay-as-you-go instance APIs

      Used by actions: CreatePostPaidInstance.

      Name Type Description
      ReturnCode String Returned code. 0 indicates normal status while other codes indicate errors.
      ReturnMessage String Message returned by the API. An error message will be returned if the API reports an error.
      Data CreateInstancePostData Returned data. Note: This field may return null, indicating that no valid values can be obtained.

      CreateInstancePreData

      Data returned by the CreateInstancePre API.

      Used by actions: DeleteInstancePre, ModifyInstancePre.

      Name Type Description
      FlowId Integer The value returned by CreateInstancePre is 0, which is fixed and cannot be used as the query condition of CheckTaskStatus. It is only used to ensure the consistency with the backend data structure.
      Note: This field may return null, indicating that no valid values can be obtained.
      DealNames Array of String Order number list.
      Note: This field may return null, indicating that no valid values can be obtained.
      InstanceId String Instance ID. When multiple instances are purchased, the ID of the first one is returned by default . Note: This field may return null, indicating that no valid values can be obtained.
      DealNameInstanceIdMapping Array of DealInstanceDTO Mapping between orders and the purchased instances. Note: This field may return null, indicating that no valid values can be obtained.

      CreateInstancePreResp

      Data structure returned by monthly subscribed instance APIs

      Used by actions: DeleteInstancePre, ModifyInstancePre.

      Name Type Description
      ReturnCode String Returned code. 0: Normal; other values: Error.
      ReturnMessage String The message indicating whether the operation is successful.
      Data CreateInstancePreData Data returned by the operation.
      Note: This field may return null, indicating that no valid values can be obtained.

      CreateTopicResp

      Return for topic creation

      Used by actions: CreateTopic.

      Name Type Description
      TopicId String Topic ID

      DatahubTopicDTO

      DataHub topic

      Used by actions: DescribeDatahubTopics.

      Name Type Description
      Name String Name
      TopicName String Topic name
      TopicId String Topic ID
      PartitionNum Integer The number of partitions
      RetentionMs Integer Expiration time
      Note String Remarks
      Status Integer Status (1: In use; 2: Deleting)

      DatahubTopicResp

      DataHub topic response

      Used by actions: CreateDatahubTopic.

      Name Type Description
      TopicName String Topic name
      TopicId String TopicId
      Note: This field may return null, indicating that no valid values can be obtained.

      DealInstanceDTO

      Mapping between orders and CKafka instances for monthly subscribed and pay-as-you-go instance APIs.

      Used by actions: CreatePostPaidInstance, DeleteInstancePre, ModifyInstancePre.

      Name Type Description
      DealName String Order list. Note: This field may return null, indicating that no valid values can be obtained.
      InstanceIdList Array of String ID list of the purchased CKafka instances corresponding to the order list. Note: This field may return null, indicating that no valid values can be obtained.

      DescribeConnectInfoResultDTO

      Topic connection information

      Used by actions: DescribeTopicProduceConnection.

      Name Type Description
      IpAddr String IP address
      Note: This field may return null, indicating that no valid values can be obtained.
      Time String Connection time
      Note: This field may return null, indicating that no valid values can be obtained.
      IsUnSupportVersion Boolean Whether it is a supported version
      Note: This field may return null, indicating that no valid values can be obtained.

      DescribeDatahubTopicResp

      DataHub topic details

      Used by actions: DescribeDatahubTopic.

      Name Type Description
      Name String Name
      TopicName String Topic name
      TopicId String Topic ID
      PartitionNum Integer The number of partitions
      RetentionMs Integer Expiration time
      Note String Remarks
      Note: This field may return null, indicating that no valid values can be obtained.
      UserName String Username
      Password String Password
      Status Integer Status (1: In use; 2: Deleting)
      Address String Service routing address
      Note: This field may return null, indicating that no valid values can be obtained.

      DescribeDatahubTopicsResp

      DataHub topic list

      Used by actions: DescribeDatahubTopics.

      Name Type Description
      TotalCount Integer Total count
      TopicList Array of DatahubTopicDTO Topic list
      Note: This field may return null, indicating that no valid values can be obtained.

      DescribeGroup

      DescribeGroup response entity

      Used by actions: DescribeGroup.

      Name Type Description
      Group String groupId
      Protocol String Protocol used by the group.

      DynamicDiskConfig

      Dynamic disk expansion configuration

      Used by actions: DescribeInstanceAttributes, ModifyInstanceAttributes.

      Name Type Required Description
      Enable Integer No Whether to enable dynamic disk expansion configuration. 0: disable, 1: enable.
      Note: this field may return null, indicating that no valid values can be obtained.
      StepForwardPercentage Integer No Percentage of dynamic disk expansion each time.
      Note: this field may return null, indicating that no valid values can be obtained.
      DiskQuotaPercentage Integer No Disk quota threshold (in percentage) for triggering the automatic disk expansion event.
      Note: this field may return null, indicating that no valid values can be obtained.
      MaxDiskSpace Integer No Max disk space in GB.
      Note: this field may return null, indicating that no valid values can be obtained.

      DynamicRetentionTime

      Dynamic message retention time configuration

      Used by actions: DescribeInstanceAttributes, ModifyInstanceAttributes.

      Name Type Required Description
      Enable Integer No Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      DiskQuotaPercentage Integer No Disk quota threshold (in percentage) for triggering the message retention time change event
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      StepForwardPercentage Integer No Percentage by which the message retention time is shortened each time
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      BottomRetention Integer No Minimum retention time, in minutes
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      Filter

      Query filter

      Key-value pair filters for conditional filtering queries, such as filter ID, name, and status

      • If there are multiple Filter, the relationship among them is logical AND.
      • If there are multiple Values in the same Filter, the relationship among them is logical OR.

      Used by actions: DescribeInstancesDetail.

      Name Type Required Description
      Name String Yes Field to be filtered.
      Values Array of String Yes Filter value of field.

      Group

      Group entity

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      GroupName String Group name

      GroupInfoMember

      Consumer information

      Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.

      Name Type Description
      MemberId String Unique ID generated for consumer in consumer group by coordinator
      ClientId String client.id information by the client consumer SDK
      ClientHost String Generally stores client IP address
      Assignment Assignment Stores the information of partition assigned to this consumer

      GroupInfoResponse

      GroupInfo response data entity

      Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.

      Name Type Description
      ErrorCode String Error code. 0: success
      State String Group status description (common valid values: Empty, Stable, Dead):
      Dead: the consumer group does not exist
      Empty: there are currently no consumer subscriptions in the consumer group
      PreparingRebalance: the consumer group is currently in rebalance state
      CompletingRebalance: the consumer group is currently in rebalance state
      Stable: each consumer in the consumer group has joined and is in stable state
      ProtocolType String The type of protocol selected by the consumer group, which is consumer for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is connect. Only with the standard consumer protocol can this API get to know the specific assigning method and parse the specific partition assignment
      Protocol String Consumer partition assignment algorithm, such as range (which is the default value for the Kafka consumer SDK), roundrobin, and sticky
      Members Array of GroupInfoMember This array contains information only if state is Stable and protocol_type is consumer
      Group String Kafka consumer group

      GroupInfoTopics

      Internal topic object of GroupInfo

      Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.

      Name Type Description
      Topic String Name of assigned topics
      Partitions Array of Integer Information of assigned partition
      Note: this field may return null, indicating that no valid values can be obtained.

      GroupOffsetPartition

      Group offset partition object

      Used by actions: DescribeGroupOffsets.

      Name Type Description
      Partition Integer Topic partitionId
      Offset Integer Offset position submitted by consumer
      Metadata String Metadata can be passed in for other purposes when the consumer submits messages. Currently, this parameter is usually an empty string
      Note: this field may return null, indicating that no valid values can be obtained.
      ErrorCode Integer Error code
      LogEndOffset Integer Latest offset of current partition
      Lag Integer Number of unconsumed messages

      GroupOffsetResponse

      Returned result of consumer group offset

      Used by actions: DescribeGroupOffsets.

      Name Type Description
      TotalCount Integer Total number of eligible results
      TopicList Array of GroupOffsetTopic Array of partitions in the topic, where each element is a JSON object
      Note: this field may return null, indicating that no valid values can be obtained.

      GroupOffsetTopic

      Consumer group topic object

      Used by actions: DescribeGroupOffsets.

      Name Type Description
      Topic String Topic name
      Partitions Array of GroupOffsetPartition Array of partitions in the topic, where each element is a JSON object
      Note: this field may return null, indicating that no valid values can be obtained.

      GroupResponse

      DescribeGroup response

      Used by actions: DescribeGroup.

      Name Type Description
      TotalCount Integer Count
      Note: this field may return null, indicating that no valid values can be obtained.
      GroupList Array of DescribeGroup GroupList
      Note: this field may return null, indicating that no valid values can be obtained.
      GroupCountQuota Integer Consumer group quota
      Note: This field may return null, indicating that no valid values can be obtained.

      InquireCkafkaPriceResp

      Values returned by the InquireCkafkaPrice API

      Used by actions: InquireCkafkaPrice.

      Name Type Description
      InstancePrice InquiryPrice Instance price
      Note: This field may return null, indicating that no valid values can be obtained.
      PublicNetworkBandwidthPrice InquiryPrice Public network bandwidth price
      Note: This field may return null, indicating that no valid values can be obtained.

      InquiryBasePrice

      Response parameters for instance price query

      Used by actions: InquireCkafkaPrice.

      Name Type Description
      UnitPrice Float Original unit price
      Note: This field may return null, indicating that no valid values can be obtained.
      UnitPriceDiscount Float Discounted unit price
      Note: This field may return null, indicating that no valid values can be obtained.
      OriginalPrice Float Original price in total
      Note: This field may return null, indicating that no valid values can be obtained.
      DiscountPrice Float Discounted price in total
      Note: This field may return null, indicating that no valid values can be obtained.
      Discount Float Discount (%)
      Note: This field may return null, indicating that no valid values can be obtained.
      GoodsNum Integer Number of purchased items
      Note: This field may return null, indicating that no valid values can be obtained.
      Currency String Currency for payment
      Note: This field may return null, indicating that no valid values can be obtained.
      DiskType String Dedicated disk response parameter
      Note: This field may return null, indicating that no valid values can be obtained.
      TimeSpan Integer Validity period
      Note: This field may return null, indicating that no valid values can be obtained.
      TimeUnit String Unit of the validity period (m: Month; h: Hour)
      Note: This field may return null, indicating that no valid values can be obtained.
      Value Integer Purchase quantity
      Note: This field may return null, indicating that no valid values can be obtained.

      InquiryDetailPrice

      Prices of different purchased items

      Used by actions: InquireCkafkaPrice.

      Name Type Description
      BandwidthPrice InquiryBasePrice Price of additional private network bandwidth
      Note: This field may return null, indicating that no valid values can be obtained.
      DiskPrice InquiryBasePrice Disk price
      Note: This field may return null, indicating that no valid values can be obtained.
      PartitionPrice InquiryBasePrice Price of additional partitions
      Note: This field may return null, indicating that no valid values can be obtained.
      TopicPrice InquiryBasePrice Price of additional topics
      Note: This field may return null, indicating that no valid values can be obtained.
      InstanceTypePrice InquiryBasePrice Instance package price
      Note: This field may return null, indicating that no valid values can be obtained.

      InquiryDiskParam

      Disk purchase parameters

      Used by actions: InquireCkafkaPrice.

      Name Type Required Description
      DiskType String No Disk type. Valid values: SSD (SSD), CLOUD_SSD (SSD cloud disk), CLOUD_PREMIUM (Premium cloud disk), CLOUD_BASIC (Cloud disk).
      DiskSize Integer No Size of the purchased disk in GB

      InquiryPrice

      Response parameters for instance price query

      Used by actions: InquireCkafkaPrice.

      Name Type Description
      UnitPrice Float Original unit price
      Note: This field may return null, indicating that no valid values can be obtained.
      UnitPriceDiscount Float Discounted unit price
      Note: This field may return null, indicating that no valid values can be obtained.
      OriginalPrice Float Original price in total
      Note: This field may return null, indicating that no valid values can be obtained.
      DiscountPrice Float Discounted price in total
      Note: This field may return null, indicating that no valid values can be obtained.
      Discount Float Discount (%)
      Note: This field may return null, indicating that no valid values can be obtained.
      GoodsNum Integer Number of purchased items
      Note: This field may return null, indicating that no valid values can be obtained.
      Currency String Currency for payment
      Note: This field may return null, indicating that no valid values can be obtained.
      DiskType String Dedicated disk response parameter
      Note: This field may return null, indicating that no valid values can be obtained.
      TimeSpan Integer Validity period
      Note: This field may return null, indicating that no valid values can be obtained.
      TimeUnit String Unit of the validity period (m: Month; h: Hour)
      Note: This field may return null, indicating that no valid values can be obtained.
      Value Integer Purchase quantity
      Note: This field may return null, indicating that no valid values can be obtained.
      DetailPrices InquiryDetailPrice Prices of different purchased items
      Note: This field may return null, indicating that no valid values can be obtained.

      InquiryPublicNetworkParam

      Public network bandwidth parameters

      Used by actions: InquireCkafkaPrice.

      Name Type Required Description
      PublicNetworkChargeType String No Public network bandwidth billing mode (BANDWIDTH_PREPAID: Monthly subscription; BANDWIDTH_POSTPAID_BY_HOUR: Bill-by-hour)
      PublicNetworkMonthly Integer No Public network bandwidth in MB

      Instance

      Instance object

      Used by actions: DescribeInstances.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      Status Integer Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed
      IfCommunity Boolean Whether it is an open-source instance. true: yes, false: no
      Note: this field may return null, indicating that no valid values can be obtained.

      InstanceAttributesResponse

      Returned result object of instance attributes

      Used by actions: DescribeInstanceAttributes.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      VipList Array of VipEntity VIP list information of access point
      Vip String Virtual IP
      Vport String Virtual port
      Status Integer Instance status. 0: creating, 1: running, 2: deleting
      Bandwidth Integer Instance bandwidth in Mbps
      DiskSize Integer Instance storage capacity in GB
      ZoneId Integer AZ
      VpcId String VPC ID. If this parameter is empty, it means the basic network
      SubnetId String Subnet ID. If this parameter is empty, it means the basic network
      Healthy Integer Instance health status. 1: healthy, 2: alarmed, 3: exceptional
      HealthyMessage String Instance health information. Currently, the disk utilization is displayed with a maximum length of 256
      CreateTime Integer Creation time
      MsgRetentionTime Integer Message retention period in minutes
      Config InstanceConfigDO Configuration for automatic topic creation. If this field is empty, it means that automatic creation is not enabled
      RemainderPartitions Integer Number of remaining creatable partitions
      RemainderTopics Integer Number of remaining creatable topics
      CreatedPartitions Integer Number of partitions already created
      CreatedTopics Integer Number of topics already created
      Tags Array of Tag Tag array
      Note: this field may return null, indicating that no valid values can be obtained.
      ExpireTime Integer Expiration time
      Note: this field may return null, indicating that no valid values can be obtained.
      ZoneIds Array of Integer Cross-AZ
      Note: this field may return null, indicating that no valid values can be obtained.
      Version String Kafka version information
      Note: this field may return null, indicating that no valid values can be obtained.
      MaxGroupNum Integer Maximum number of groups
      Note: this field may return null, indicating that no valid values can be obtained.
      Cvm Integer Offering type. 0: Standard Edition; 1: Professional Edition
      Note: this field may return null, indicating that no valid value was found.
      InstanceType String Type.
      Note: this field may return null, indicating that no valid value was found.
      Features Array of String Features supported by the instance. FEATURE_SUBNET_ACL indicates that the ACL policy supports setting subnets.
      Note: this field may return null, indicating that no valid values can be obtained.
      RetentionTimeConfig DynamicRetentionTime Dynamic message retention policy
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      MaxConnection Integer Maximum number of connections
      Note: this field may return null, indicating that no valid values can be obtained.
      PublicNetwork Integer Public network bandwidth
      Note: this field may return null, indicating that no valid values can be obtained.
      DeleteRouteTimestamp String Time
      Note: this field may return null, indicating that no valid values can be obtained.
      RemainingPartitions Integer Number of remaining creatable partitions
      Note: this field may return null, indicating that no valid values can be obtained.
      RemainingTopics Integer Number of remaining creatable topics
      Note: this field may return null, indicating that no valid values can be obtained.
      DynamicDiskConfig DynamicDiskConfig Dynamic disk expansion policy.
      Note: this field may return null, indicating that no valid values can be obtained.

      InstanceChargeParam

      Instance billing parameters

      Used by actions: InquireCkafkaPrice.

      Name Type Required Description
      InstanceChargeType String No Instance billing mode (PREPAID: Monthly subscription; POSTPAID_BY_HOUR: Pay-as-you-go)
      InstanceChargePeriod Integer No Validity period, which is only required for the monthly subscription billing mode

      InstanceConfigDO

      Instance configuration entity

      Used by actions: DescribeInstanceAttributes.

      Name Type Description
      AutoCreateTopicsEnable Boolean Whether to create topics automatically
      DefaultNumPartitions Integer Number of partitions
      DefaultReplicationFactor Integer Default replication factor

      InstanceDetail

      Instance details

      Used by actions: DescribeInstancesDetail.

      Name Type Description
      InstanceId String Instance ID
      InstanceName String Instance name
      Vip String Instance VIP information
      Vport String Instance port information
      VipList Array of VipEntity Virtual IP list
      Status Integer Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed
      Bandwidth Integer Instance bandwidth in Mbps
      DiskSize Integer Instance storage capacity in GB
      ZoneId Integer AZ ID
      VpcId String vpcId. If this parameter is empty, it means the basic network
      SubnetId String Subnet ID
      RenewFlag Integer Whether to renew the instance automatically, which is an int-type enumerated value. 1: yes, 2: no
      Healthy Integer Instance status. An int-type value will be returned. 0: Healthy, 1: Alarmed, 2: Exceptional
      HealthyMessage String Instance status information
      CreateTime Integer Instance creation time
      ExpireTime Integer Instance expiration time
      IsInternal Integer Whether it is an internal customer. 1: yes
      TopicNum Integer Number of topics
      Tags Array of Tag Tag
      Version String Kafka version information
      Note: this field may return null, indicating that no valid values can be obtained.
      ZoneIds Array of Integer Cross-AZ
      Note: this field may return null, indicating that no valid values can be obtained.
      Cvm Integer CKafka sale type
      Note: this field may return null, indicating that no valid values can be obtained.
      InstanceType String CKafka instance type
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      DiskType String Disk type
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      MaxTopicNumber Integer Maximum number of topics for the current instance
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      MaxPartitionNumber Integer Maximum number of partitions for the current instance
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      RebalanceTime String Time of scheduled upgrade
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      PartitionNumber Integer Number of partitions in the current instance.
      Note: this field may return null, indicating that no valid values can be obtained.
      PublicNetworkChargeType String Public network bandwidth type.
      Note: this field may return null, indicating that no valid values can be obtained.
      PublicNetwork Integer Public network bandwidth.
      Note: this field may return null, indicating that no valid values can be obtained.
      ClusterType String Instance type.
      Note: This field may return null, indicating that no valid values can be obtained.
      Features Array of String Instance feature list.
      Note: This field may return null, indicating that no valid values can be obtained.

      InstanceDetailResponse

      Returned result of instance details

      Used by actions: DescribeInstancesDetail.

      Name Type Description
      TotalCount Integer Total number of eligible instances
      InstanceList Array of InstanceDetail List of eligible instance details

      InstanceQuotaConfigResp

      Traffic throttling policy in instance/topic dimension

      Used by actions: DescribeTopicAttributes.

      Name Type Description
      QuotaProducerByteRate Integer Production throttling in MB/sec.
      Note: This field may return null, indicating that no valid values can be obtained.
      QuotaConsumerByteRate Integer Consumption throttling in MB/sec.
      Note: This field may return null, indicating that no valid values can be obtained.

      InstanceResponse

      Aggregated returned result of instance status

      Used by actions: DescribeInstances.

      Name Type Description
      InstanceList Array of Instance List of eligible instances
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalCount Integer Total number of eligible results
      Note: this field may return null, indicating that no valid values can be obtained.

      JgwOperateResponse

      Returned result value of operation

      Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreateInstancePost, CreatePartition, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes.

      Name Type Description
      ReturnCode String Returned code. 0: normal, other values: error
      ReturnMessage String Success message
      Data OperateResponseData Data returned by an operation, which may contain flowId, etc.
      Note: this field may return null, indicating that no valid values can be obtained.

      ModifyInstanceAttributesConfig

      Configuration object for modifying instance attributes

      Used by actions: ModifyInstanceAttributes.

      Name Type Required Description
      AutoCreateTopicEnable Boolean No Automatic creation. true: enabled, false: not enabled
      DefaultNumPartitions Integer No Optional. If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default
      DefaultReplicationFactor Integer No If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default

      OperateResponseData

      Data structure returned by operation

      Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreateInstancePost, CreatePartition, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes.

      Name Type Description
      FlowId Integer FlowId11
      Note: this field may return null, indicating that no valid values can be obtained.
      RouteDTO RouteDTO RouteIdDto Note: This field may return null, indicating that no valid values can be obtained.

      Partition

      Partition entity

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      PartitionId Integer Partition ID

      PartitionOffset

      Partition and offset

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      Partition String Partition, such as "0" or "1"
      Note: this field may return null, indicating that no valid values can be obtained.
      Offset Integer Offset, such as 100
      Note: this field may return null, indicating that no valid values can be obtained.

      Partitions

      Partition information

      Used by actions: BatchModifyGroupOffsets.

      Name Type Required Description
      Partition Integer Yes Partition.
      Offset Integer Yes Partition consumption offset.

      Price

      Message price entity

      Used by actions: DescribeCkafkaZone.

      Name Type Description
      RealTotalCost Float Discounted price
      TotalCost Float Original price

      Region

      Region entity object

      Used by actions: DescribeRegion.

      Name Type Description
      RegionId Integer Region ID
      RegionName String Region name
      AreaName String Area name
      RegionCode String Region code
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      RegionCodeV3 String Region code (v3)
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Support String NONE: no special models are supported by default.\nCVM: the CVM type is supported.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Ipv6 Integer Whether IPv6 is supported. 0 indicates no, and 1 indicates yes.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      MultiZone Integer Whether cross-AZ clusters are supported.0 indicates no, and 1 indicates yes.
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      Route

      Route entity object

      Used by actions: DescribeRoute.

      Name Type Description
      AccessType Integer Instance connection method
      0: PLAINTEXT (plaintext method, which does not carry user information and is supported for legacy versions and Community Edition)
      1: SASL_PLAINTEXT (plaintext method, which authenticates the login through SASL before data start and is supported only for Community Edition)
      2: SSL (SSL-encrypted communication, which does not carry user information and is supported for legacy versions and Community Edition)
      3: SASL_SSL (SSL-encrypted communication, which authenticates the login through SASL before data start and is supported only for Community Edition)
      RouteId Integer Route ID
      VipType Integer VIP network type (1: Public network TGW; 2: Classic network; 3: VPC; 4: Supporting network (IDC environment); 5: SSL public network access; 6: BM VPC; 7: Supporting network (CVM environment)).
      VipList Array of VipEntity Virtual IP list
      Domain String Domain name
      Note: this field may return null, indicating that no valid values can be obtained.
      DomainPort Integer Domain name port
      Note: this field may return null, indicating that no valid values can be obtained.
      DeleteTimestamp String Timestamp
      Note: this field may return null, indicating that no valid values can be obtained.

      RouteDTO

      RouteDTO

      Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreateInstancePost, CreatePartition, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyTopicAttributes.

      Name Type Description
      RouteId Integer RouteId11 Note: This field may return null, indicating that no valid values can be obtained.

      RouteResponse

      Returned object for route information

      Used by actions: DescribeRoute.

      Name Type Description
      Routers Array of Route Route information list
      Note: this field may return null, indicating that no valid values can be obtained.

      SaleInfo

      Sales information of Standard Edition

      Used by actions: DescribeCkafkaZone.

      Name Type Description
      Flag Boolean Manually set flag.
      Note: this field may return null, indicating that no valid values can be obtained.
      Version String CKafka version (v1.1.1/2.4.2/0.10.2）
      Note: this field may return null, indicating that no valid values can be obtained.
      Platform String Whether it is Pro Edition or Standard Edition.
      Note: this field may return null, indicating that no valid values can be obtained.
      SoldOut Boolean Whether it has been sold out. true: sold out.
      Note: this field may return null, indicating that no valid values can be obtained.

      SubscribedInfo

      Subscribed message entity

      Used by actions: DescribeConsumerGroup.

      Name Type Description
      TopicName String Subscribed topic name
      Partition Array of Integer Subscribed partition
      Note: this field may return null, indicating that no valid values can be obtained.
      PartitionOffset Array of PartitionOffset Partition offset information
      Note: this field may return null, indicating that no valid values can be obtained.
      TopicId String ID of the subscribed topic.
      Note: this field may return null, indicating that no valid values can be obtained.

      Tag

      Tag object in instance details

      Used by actions: CreateDatahubTopic, CreateTopic, DescribeInstanceAttributes, DescribeInstancesDetail, DescribeTopicDetail, ModifyDatahubTopic, ModifyTopicAttributes.

      Name Type Required Description
      TagKey String Yes Tag key
      TagValue String Yes Tag value

      TaskStatusResponse

      Returned task status

      Used by actions: DescribeTaskStatus.

      Name Type Description
      Status Integer Task status. 0 (Successful), 1 (Failed), 2 ( Running)
      Output String Output information Note: This field may return null, indicating that no valid values can be obtained.

      Topic

      Returned topic object

      Used by actions: DescribeTopic.

      Name Type Description
      TopicId String Topic ID
      TopicName String Topic name
      Note String Remarks
      Note: this field may return null, indicating that no valid values can be obtained.

      TopicAttributesResponse

      Returned topic attributes result entity

      Used by actions: DescribeTopicAttributes.

      Name Type Description
      TopicId String Topic ID
      CreateTime Integer Creation time
      Note String Topic remarks
      Note: this field may return null, indicating that no valid values can be obtained.
      PartitionNum Integer Number of partitions
      EnableWhiteList Integer IP allowlist switch. 1: enabled, 0: disabled
      IpWhiteList Array of String IP allowlist list
      Config Config Topic configuration array
      Partitions Array of TopicPartitionDO Partition details
      EnableAclRule Integer Switch of the preset ACL rule. 1: enable, 0: disable.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      AclRuleList Array of AclRule Preset ACL rule list.
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      QuotaConfig InstanceQuotaConfigResp Traffic throttling policy in topic dimension.
      Note: This field may return null, indicating that no valid values can be obtained.
      ReplicaNum Integer Number of replicas
      Note: This field may return null, indicating that no valid values can be obtained.

      TopicDetail

      Topic details

      Used by actions: DescribeTopicDetail.

      Name Type Description
      TopicName String Topic name
      TopicId String Topic ID
      PartitionNum Integer Number of partitions
      ReplicaNum Integer Number of replicas
      Note String Remarks
      Note: this field may return null, indicating that no valid values can be obtained.
      CreateTime Integer Creation time
      EnableWhiteList Boolean Whether to enable IP authentication allowlist. true: yes, false: no
      IpWhiteListCount Integer Number of IPs in IP allowlist
      ForwardCosBucket String COS bucket for data backup: address of the destination COS bucket
      Note: this field may return null, indicating that no valid values can be obtained.
      ForwardStatus Integer Status of data backup to COS. 1: not enabled, 0: enabled
      ForwardInterval Integer Frequency of data backup to COS
      Config Config Advanced configuration
      Note: this field may return null, indicating that no valid values can be obtained.
      RetentionTimeConfig TopicRetentionTimeConfigRsp Message retention time configuration (for recording the latest retention time)
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Status Integer 0: normal, 1: deleted, 2: deleting
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Tags Array of Tag Tag list
      Note: This field may return null, indicating that no valid values can be obtained.

      TopicDetailResponse

      Returned topic details entity

      Used by actions: DescribeTopicDetail.

      Name Type Description
      TopicList Array of TopicDetail List of returned topic details
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalCount Integer Number of all eligible topic details

      TopicInSyncReplicaInfo

      Topic replica and details

      Used by actions: DescribeTopicSyncReplica.

      Name Type Description
      Partition String Partition name
      Leader Integer Leader ID
      Replica String Replica set
      InSyncReplica String ISR
      BeginOffset Integer Starting offset
      Note: this field may return null, indicating that no valid values can be obtained.
      EndOffset Integer Ending offset
      Note: this field may return null, indicating that no valid values can be obtained.
      MessageCount Integer Number of messages
      Note: this field may return null, indicating that no valid values can be obtained.
      OutOfSyncReplica String Unsynced replica set
      Note: this field may return null, indicating that no valid values can be obtained.

      TopicInSyncReplicaResult

      Set of topic replicas and details

      Used by actions: DescribeTopicSyncReplica.

      Name Type Description
      TopicInSyncReplicaList Array of TopicInSyncReplicaInfo Set of topic details and replicas
      TotalCount Integer Total number

      TopicPartitionDO

      Partition details

      Used by actions: DescribeTopicAttributes.

      Name Type Description
      Partition Integer Partition ID
      LeaderStatus Integer Leader running status
      IsrNum Integer ISR quantity
      ReplicaNum Integer Number of replicas

      TopicResult

      TopicResponse returned uniformly

      Used by actions: DescribeTopic.

      Name Type Description
      TopicList Array of Topic List of returned topic information
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalCount Integer Number of eligible topics
      Note: this field may return null, indicating that no valid values can be obtained.

      TopicRetentionTimeConfigRsp

      Information returned for topic message retention time configuration

      Used by actions: DescribeTopicDetail.

      Name Type Description
      Expect Integer Expected value, i.e., the topic message retention time (min) configured
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Current Integer Current value (min), i.e., the retention time currently in effect, which may be dynamically adjusted
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      ModTimeStamp Integer Last modified time
      Note: null may be returned for this field, indicating that no valid values can be obtained.

      TopicSubscribeGroup

      DescribeTopicSubscribeGroup output parameters

      Used by actions: DescribeTopicSubscribeGroup.

      Name Type Description
      TotalCount Integer Total number
      StatusCountInfo String Number of consumer group status
      GroupsInfo Array of GroupInfoResponse Consumer group information
      Note: this field may return null, indicating that no valid values can be obtained.
      Status Integer Whether a request is asynchronous. If there are fewer consumer groups in the instances, the result will be returned directly, and status code is 1. When there are many consumer groups in the instances, cache will be updated asynchronously. When status code is 0, grouping information will not be returned until cache update is completed and status code becomes 1.
      Note: this field may return null, indicating that no valid values can be obtained.

      User

      User entity

      Used by actions: DescribeUser.

      Name Type Description
      UserId Integer User ID
      Name String Username
      CreateTime Timestamp Creation time
      UpdateTime Timestamp Last updated time

      UserResponse

      Returned user entity

      Used by actions: DescribeUser.

      Name Type Description
      Users Array of User List of eligible users
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalCount Integer Total number of eligible users

      VipEntity

      Virtual IP entity

      Used by actions: DescribeInstanceAttributes, DescribeInstancesDetail, DescribeRoute.

      Name Type Description
      Vip String Virtual IP
      Vport String Virtual port

      ZoneInfo

      Zone information entity

      Used by actions: DescribeCkafkaZone.

      Name Type Description
      ZoneId String Zone ID
      IsInternalApp Integer Whether it is an internal application.
      AppId Integer Application ID
      Flag Boolean Flag
      ZoneName String Zone name
      ZoneStatus Integer Zone status
      Exflag String Extra flag
      SoldOut String JSON object. The key is the model. The value true means “sold out”, and false means “not sold out”.
      SalesInfo Array of SaleInfo Information on whether Standard Edition has been sold out.
      Note: this field may return null, indicating that no valid values can be obtained.

      ZoneResponse

      The entity returned for the query of Kafka’s zone information

      Used by actions: DescribeCkafkaZone.

      Name Type Description
      ZoneList Array of ZoneInfo Zone list
      MaxBuyInstanceNum Integer Maximum number of instances to be purchased
      MaxBandwidth Integer Maximum bandwidth in MB/S
      UnitPrice Price Pay-as-you-go unit price
      MessagePrice Price Pay-as-you-go unit message price
      ClusterInfo Array of ClusterInfo Cluster information dedicated to a user
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Standard String Purchase of Standard Edition configurations
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      StandardS2 String Purchase of Standard S2 Edition configurations
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Profession String Purchase of Pro Edition configurations
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      Physical String Purchase of Physical Dedicated Edition configurations
      Note: null may be returned for this field, indicating that no valid values can be obtained.
      PublicNetwork String Public network bandwidth.
      Note: this field may return null, indicating that no valid values can be obtained.
      PublicNetworkLimit String Public network bandwidth configuration.
      Note: this field may return null, indicating that no valid values can be obtained.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy