Data Types

Download PDF

Last updated: 2025-12-02 10:59:36

Data Types

Last updated: 2025-12-02 10:59:36

Download PDF

ClientSubscriptionInfo

Client subscription details, which are used to help determine clients with inconsistent subscription relationships.

Used by actions: DescribeTopic, DescribeTopicListByGroup.

Name	Type	Description
ClientId	String	Client ID
ClientAddr	String	Client ip address.
Topic	String	Specifies the subscribed topic.
SubString	String	Subscription expression.
ExpressionType	String	Specifies the subscription method.

ConsumerClient

Consumer client

Used by actions: DescribeConsumerClient, DescribeConsumerClientList, DescribeMigratingGroupStats.

Name	Type	Description
ClientId	String	Client ID
ClientAddr	String	Client address.
Language	String	Client SDK language
Version	String	Client SDK version
ConsumerLag	Integer	Client consumption heap Note: This field may return null, indicating that no valid values can be obtained.
ChannelProtocol	String	Consumer client type. valid values:. -Specifies the grpc protocol. -remoting protocol. -http protocol. Note: This field may return null, indicating that no valid values can be obtained.

DetailedRolePerm

Permission configuration in Topic & Group dimension.

Used by actions: CreateRole, DescribeRoleList, ModifyRole.

Name	Type	Required	Description
Resource	String	Yes	Resources corresponding to permissions. Specifies the topic name, which can be obtained from TopicItem returned by the api DescribeTopicList or from the console. Specifies the consumer group name, which can be obtained from the api response of DescribeConsumerGroupList (https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or the console.
PermWrite	Boolean	Yes	Whether to enable production permission
PermRead	Boolean	Yes	Whether to enable consumption permission
ResourceType	String	Yes	Authorize resource type (Topic: theme; Group: consumption Group).
Remark	String	No	Resource remark.

Endpoint

Access point information.

Used by actions: DescribeInstance.

Name	Type	Description
Type	String	Access point type, with the enumerated values as follows:. - VPC: specifies the VPC network. -PUBLIC: public network. -INTERNAL: specifies the support network.
Status	String	Status. OPEN: indicates to start or activate a function. CLOSE: indicates the closed state. PROCESSING: operation in progress.
PayMode	String	Payment type, only public network. PREPAID: annual/monthly package. Pay-As-You-Go. Note: This field may return null, indicating that no valid values can be obtained.
EndpointUrl	String	Access point address. Note: This field may return null, indicating that no valid values can be obtained.
VpcId	String	VPC ID Note: This field may return null, indicating that no valid values can be obtained.
SubnetId	String	Specifies the subnet ID. Note: This field may return null, indicating that no valid values can be obtained.
Bandwidth	Integer	Public network bandwidth, in Mbps Note: This field may return null, indicating that no valid values can be obtained.
IpRules	Array of IpRule	Public network access rules Note: This field may return null, indicating that no valid values can be obtained.
BillingFlow	Boolean	Whether the public network is billed by traffic. Note: This field may return null, indicating that no valid values can be obtained.

Filter

Query filter

Used by actions: DescribeConsumerClient, DescribeConsumerClientList, DescribeFusionInstanceList, DescribeInstanceList, DescribeMigratingTopicList, DescribeMigrationTaskList, DescribeProducerList, DescribeRoleList, DescribeSmoothMigrationTaskList, DescribeSourceClusterGroupList, DescribeTopic, DescribeTopicList, DescribeTopicListByGroup.

Name	Type	Required	Description
Name	String	Yes	Filter condition parameter name.
Values	Array of String	Yes	Filter criterion value

FusionInstanceItem

Instance information on the instance list page

Used by actions: DescribeFusionInstanceList.

Name	Type	Description
InstanceId	String	Instance ID
InstanceName	String	Instance name
Version	String	Instance version.
InstanceType	String	Instance type. Trial version. BASIC version. PRO, professional edition. PLATINUM edition.
InstanceStatus	String	Instance status. RUNNING. specifies the running status. MAINTAINING. ABNORMAL. OVERDUE. specifies the state of arrears. `DESTROYED`: `deleted`. CREATING. MODIFYING. CREATE_FAILURE. specifies that the creation failed. MODIFY_FAILURE. indicates a configuration adjustment failure. Valid values: DELETING. indicates that the resource is being deleted.
TopicNumLimit	Integer	Maximum number of instance topics
GroupNumLimit	Integer	Maximum number of instance consumer groups
PayMode	String	Billing mode. valid enumeration values are as follows:. -POSTPAID: pay-as-you-go. - PREPAID: monthly subscription.
ExpiryTime	Integer	Expiration time. It is a Unix timestamp (ms). Note: This field may return null, indicating that no valid values can be obtained.
Remark	String	Remarks Note: This field may return null, indicating that no valid values can be obtained.
TopicNum	Integer	Number of topics
GroupNum	Integer	Number of consumer groups
TagList	Array of Tag	Tag list Note: This field may return null, indicating that no valid values can be obtained.
SkuCode	String	Specifies the product specification.
TpsLimit	Integer	TPS throttle value Note: This field may return null, indicating that no valid values can be obtained.
ScaledTpsLimit	Integer	Elastic TPS throttle value
MessageRetention	Integer	Message retention time, in hours
MaxMessageDelay	Integer	Maximum delayed message duration, in hours
RenewFlag	Integer	Specifies whether the prepaid cluster is automatically renewed. valid values are as follows:. - 0: no automatic renewal. - 1: specifies automatic renewal.
InstanceItemExtraInfo	InstanceItemExtraInfo	Data unique to version 4.x. Note: This field may return null, indicating that no valid values can be obtained.
DestroyTime	Integer	Expected termination time. It is a Unix timestamp (ms). Note: This field may return null, indicating that no valid values can be obtained.
ZoneIds	Array of Integer	AZ list. See ZoneInfo returned by the API DescribeZones in Data Type. Note: This field may return null, indicating that no valid values can be obtained.
EnableDeletionProtection	Boolean	Whether to enable deletion protection
CreateTime	Integer	Instance creation time Note: This field may return null, indicating that no valid values can be obtained.
ScaledTpsEnabled	Boolean	Elastic TPS switch. Note: This field may return null, indicating that no valid values can be obtained.

InstanceItem

Instance information on the instance list page

Used by actions: DescribeInstanceList.

Name	Type	Description
InstanceId	String	Instance ID
InstanceName	String	Instance name
Version	String	Instance version.
InstanceType	String	Instance type. Trial version. BASIC version. PRO, professional edition. PLATINUM edition.
InstanceStatus	String	Instance status. RUNNING. specifies the running status. MAINTAINING. ABNORMAL. OVERDUE. specifies the state of arrears. `DESTROYED`: deleted. CREATING. MODIFYING. CREATE_FAILURE. specifies that the creation failed. MODIFY_FAILURE. indicates a configuration adjustment failure. DELETING.
TopicNumLimit	Integer	Maximum number of instance topics
GroupNumLimit	Integer	Maximum number of instance consumer groups
PayMode	String	Billing mode. valid enumeration values are as follows:. -POSTPAID: pay-as-you-go. - PREPAID: monthly subscription.
ExpiryTime	Integer	Expiration timestamp. It is a Unix timestamp (ms). Note: This field may return null, indicating that no valid values can be obtained.
Remark	String	Remarks Note: This field may return null, indicating that no valid values can be obtained.
TopicNum	Integer	Number of topics
GroupNum	Integer	Number of consumer groups
TagList	Array of Tag	Tag list Note: This field may return null, indicating that no valid values can be obtained.
SkuCode	String	Specifies the product specification.
TpsLimit	Integer	TPS throttle value
ScaledTpsLimit	Integer	Elastic TPS throttle value
MessageRetention	Integer	Message retention time, in hours
MaxMessageDelay	Integer	Maximum delayed message duration, in hours
RenewFlag	Integer	Whether automatic renewal is enabled. This parameter is valid only for prepaid clusters. 0: automatic renewal disabled; 1: automatic renewal enabled.

InstanceItemExtraInfo

Unified list display for 4.x clusters and 5.0 clusters shows the 4.x special data carrying interface.

Used by actions: DescribeFusionInstanceList.

Name	Type	Description
IsVip	Boolean	Whether it is a vip. Note: This field may return null, indicating that no valid values can be obtained.
VipInstanceStatus	Integer	Specifies the dedicated cluster status of version 4.x. Note: This field may return null, indicating that no valid values can be obtained.
MaxBandWidth	Integer	Specifies the peak bandwidth of the dedicated cluster. Note: This field may return null, indicating that no valid values can be obtained.
SpecName	String	Exclusive cluster specification. Note: This field may return null, indicating that no valid values can be obtained.
NodeCount	Integer	Specifies the quantity of exclusive cluster nodes. Note: This field may return null, indicating that no valid values can be obtained.
MaxStorage	Integer	Specifies the maximum storage of the dedicated cluster. Note: This field may return null, indicating that no valid values can be obtained.
MaxRetention	Integer	Specifies the maximum retention time of the dedicated cluster. the unit is hour. Note: This field may return null, indicating that no valid values can be obtained.
MinRetention	Integer	Special project cluster maximum retention time, unit: hr. Note: This field may return null, indicating that no valid values can be obtained.
InstanceStatus	Integer	Status of 4.0 shared cluster. Note: This field may return null, indicating that no valid values can be obtained.
IsFrozen	Boolean	Whether it is frozen.

IpRule

IP rules

Used by actions: CreateInstance, DescribeInstance, ModifyInstanceEndpoint.

Name	Type	Required	Description
Ip	String	Yes	Specifies the IP address.
Allow	Boolean	Yes	Whether the IP address is allowed. Default value: false, indicating that the IP address is denied.
Remark	String	Yes	Remarks

MessageItem

Message log

Used by actions: DescribeMessageList.

Name	Type	Description
MsgId	String	Message ID. Note: This field may return null, indicating that no valid values can be obtained.
Tags	String	Message tag Note: This field may return null, indicating that no valid values can be obtained.
Keys	String	Message key. Note: This field may return null, indicating that no valid values can be obtained.
ProducerAddr	String	Client address. Note: This field may return null, indicating that no valid values can be obtained.
ProduceTime	String	Message Sending Time Note: This field may return null, indicating that no valid values can be obtained.
DeadLetterResendTimes	Integer	Dead-letter resend count Note: This field may return null, indicating that no valid values can be obtained.
DeadLetterResendSuccessTimes	Integer	Dead Letter Resend Success Count Note: This field may return null, indicating that no valid values can be obtained.

MessageTraceItem

Message trace.

Used by actions: DescribeMessageTrace.

Name	Type	Description
Stage	String	Message handling phase. valid values are as follows:. -Produces messages. -Persists message storage. -Consumes messages. Note: This field may return null, indicating that no valid values can be obtained.
Data	String	Track details Note: This field may return null, indicating that no valid values can be obtained.

MessageTrackItem

MessageTrack

Used by actions: DescribeMessage.

Name	Type	Description
ConsumerGroup	String	Specifies the consumer group name.
ConsumeStatus	String	Consumption status. CONSUMED: Consumed CONSUMED_BUT_FILTERED: Filtered NOT_CONSUME: Not consumed ENTER_RETRY: Enter retry queue. ENTER_DLQ: Enter dead letter queue. UNKNOWN: Consumption status unknown
TrackType	String	Track type
ExceptionDesc	String	Exception information. Note: This field may return null, indicating that no valid values can be obtained.

MigratingTopic

Migrating topic.

Used by actions: DescribeMigratingTopicList.

Name	Type	Description
TopicName	String	Topic name
MigrationStatus	String	Migration status. S_RW_D_NA source cluster read/write. S_RW_D_R specifies read and write permissions for the source cluster and read permissions for the target cluster. S_RW_D_RW specifies read-write for the source cluster and read-write for the target cluster. SRDRW specifies source cluster read and destination cluster read/write. S_NA_D_RW specifies the read-write target cluster.
HealthCheckPassed	Boolean	Specifies whether the health check is completed.
HealthCheckError	String	Error information returned by the last health check is valid only when HealthCheckPassed is false. NotChecked: check not executed. Unknown: Unknown error. TopicNotImported: topic not imported. TopicNotExistsInSourceCluster: topic does not exist in the source cluster. TopicNotExistsInTargetCluster: topic does not exist in the target cluster. ConsumerConnectedOnTarget: consumer connections exist on the target cluster. SourceTopicHasNewMessagesIn5Minutes: new messages were written to the source cluster topic in the last 5 Minutes. TargetTopicHasNewMessagesIn5Minutes: new messages were written to the target cluster topic in the last 5 Minutes. SourceTopicHasNoMessagesIn5Minutes: no new messages were written to the source cluster in the last 5 Minutes. TargetTopicHasNoMessagesIn5Minutes: no new messages were written to the target cluster in the last 5 Minutes. ConsumerGroupCountNotMatch: inconsistent number of subscription groups. SourceTopicHasUnconsumedMessages: unconsumed messages exist in the source cluster topic.
Namespace	String	Namespace. specifies that it is only valid for 4.x clusters.
NamespaceV4	String	Namespace of 4.x. Note: This field may return null, indicating that no valid values can be obtained.
TopicNameV4	String	Topic name for version 4.x. Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4	String	Complete namespace for 4.x. Note: This field may return null, indicating that no valid values can be obtained.
HealthCheckErrorList	Array of String	Error list returned from the last health check.

MigrationTaskItem

Migration task information.

Used by actions: DescribeMigrationTaskList.

Name	Type	Description
TaskId	String	Task ID
InstanceId	String	Instance ID.
Type	Integer	0 - not specified (existing). Metadata import.
TopicNum	Integer	Total number of topics.
GroupNum	Integer	Total Number of Consumer Groups
Status	Integer	Task status. 0: migrating; 1: migration successful; 2: migration completed, with only part of the data migrated.
CreateTime	Integer	Creation time.

PriceTag

Price tag information. A complete price tag includes the billing category and the billing item.

Used by actions: DescribeProductSKUs.

Name	Type	Description
Name	String	Price name. Enumeration values: tps: basic price of TPS; stepTps: TPS step size.
Step	Integer	Step size corresponding to the billing item. Note: This field may return null, indicating that no valid values can be obtained.

ProducerInfo

Producer information.

Used by actions: DescribeProducerList.

Name	Type	Description
ClientId	String	Client ID Note: This field may return null, indicating that no valid values can be obtained.
ClientIp	String	Client IP. Note: This field may return null, indicating that no valid values can be obtained.
Language	String	Client language. - JAVA((byte) 0) - CPP((byte) 1) - DOTNET((byte) 2) - PYTHON((byte) 3) - DELPHI((byte) 4) - ERLANG((byte) 5) - RUBY((byte) 6) - OTHER((byte) 7) - HTTP((byte) 8) - GO((byte) 9) - PHP((byte) 10) - OMS((byte) 11) Note: This field may return null, indicating that no valid values can be obtained.
Version	String	Client version. Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTimestamp	Integer	Last production time, Unix timestamp (seconds). Note: This field may return null, indicating that no valid values can be obtained.
ChannelProtocol	String	Producer client protocol type. valid values: the following. -Specifies the grpc protocol. -remoting protocol. -http protocol. Note: This field may return null, indicating that no valid values can be obtained.

ProductSKU

Product sales information

Used by actions: DescribeProductSKUs.

Name	Type	Description
InstanceType	String	Specifies the product type. Trial version. BASIC version. PRO, professional edition. PLATINUM edition.
SkuCode	String	Specification code
TpsLimit	Integer	TPS limit
ScaledTpsLimit	Integer	Elastic TPS upper limit
TopicNumLimit	Integer	Default maximum number of topics.
GroupNumLimit	Integer	Maximum number of consumer groups
DefaultRetention	Integer	Default message retention time, in hours
RetentionUpperLimit	Integer	Adjustable maximum message retention time, in hours
RetentionLowerLimit	Integer	Adjustable minimum message retention time, in hours
MaxMessageDelay	Integer	Maximum delayed message duration, in hours
OnSale	Boolean	Whether it is purchasable
PriceTags	Array of PriceTag	Billing item information
TopicNumUpperLimit	Integer	Default maximum number of topics.

RoleItem

Role information.

Used by actions: DescribeRoleList.

Name	Type	Required	Description
RoleName	String	Yes	Role name.
PermRead	Boolean	Yes	Whether to enable consumption.
PermWrite	Boolean	Yes	Whether to enable production
AccessKey	String	No	Access Key
SecretKey	String	No	Secret Key
Remark	String	No	Remarks
CreatedTime	Integer	No	Role creation time. It is a Unix timestamp (ms).
ModifiedTime	Integer	No	Role update time. It is a Unix timestamp (ms).
PermType	String	No	Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group level).
DetailedRolePerms	Array of DetailedRolePerm	No	Permission configuration in Topic and Group dimension. Note: This field may return null, indicating that no valid values can be obtained.

SmoothMigrationTaskItem

Hitless migration task.

Used by actions: DescribeSmoothMigrationTaskList.

Name	Type	Description
TaskId	String	Task ID Note: This field may return null, indicating that no valid values can be obtained.
TaskName	String	Task name. Note: This field may return null, indicating that no valid values can be obtained.
SourceClusterName	String	Source cluster name. Note: This field may return null, indicating that no valid values can be obtained.
InstanceId	String	Destination cluster instance ID. Note: This field may return null, indicating that no valid values can be obtained.
ConnectionType	String	Specifies the network connection type. PUBLIC network. Specifies the VPC virtual private cloud. OTHER. Note: This field may return null, indicating that no valid values can be obtained.
SourceNameServer	String	Source cluster NameServer address. Note: This field may return null, indicating that no valid values can be obtained.
TaskStatus	String	Task status. Migration Configuration. specifies the migration Configuration. SourceConnecting specifies connecting to source cluster. MetaDataImport specifies metadata import. EndpointSetup specifies the access point switchover. Service migration is in progress. Completed. Cancelled: canceled. Note: This field may return null, indicating that no valid values can be obtained.
InstanceVersion	String	Specifies the target cluster instance version. 4 indicates version 4.x. 5 indicates version 5.x. Note: This field may return null, indicating that no valid values can be obtained.

SourceClusterGroupConfig

Specifies the consumer group configuration information.

Used by actions: DescribeSourceClusterGroupList.

Name	Type	Required	Description
GroupName	String	Yes	Consumer group name. It can be obtained from SourceClusterGroupConfig returned by the API DescribeSourceClusterGroupList. Note: This field may return null, indicating that no valid values can be obtained.
Remark	String	No	Remarks Note: This field may return null, indicating that no valid values can be obtained.
Imported	Boolean	No	Specifies whether it has been imported. it is unavailable when used as an input parameter. Note: This field may return null, indicating that no valid values can be obtained.
Namespace	String	No	Namespace, valid for 4.x clusters only. Note: This field may return null, indicating that no valid values can be obtained.
ImportStatus	String	No	Import status. Unknown. specifies an unknown status. Success. Failure. AlreadyExists. specifies the resource already exists. Used as an output parameter. Note: This field may return null, indicating that no valid values can be obtained.
NamespaceV4	String	No	Namespace of 4.x. output usage. Note: This field may return null, indicating that no valid values can be obtained.
GroupNameV4	String	No	Consumer group name for version 4.x. output usage. Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4	String	No	Complete namespace for version 4.x. output usage. Note: This field may return null, indicating that no valid values can be obtained.
ConsumeMessageOrderly	Boolean	No	Specifies whether it is ordered delivery. valid value: 5.0. Note: This field may return null, indicating that no valid values can be obtained.

SubscriptionData

Topic and consumer group subscription relationship data

Used by actions: DescribeTopic, DescribeTopicListByGroup.

Name	Type	Description
InstanceId	String	Instance ID Note: This field may return null, indicating that no valid values can be obtained.
Topic	String	Topic name Note: This field may return null, indicating that no valid values can be obtained.
TopicType	String	Topic type. Note: This field may return null, indicating that no valid values can be obtained.
TopicQueueNum	Integer	Number of topic queues on a single node Note: This field may return null, indicating that no valid values can be obtained.
ConsumerGroup	String	Specifies the consumer group name. Note: This field may return null, indicating that no valid values can be obtained.
IsOnline	Boolean	Online status Note: This field may return null, indicating that no valid values can be obtained.
ConsumeType	String	Consumption type. valid values as follows:. -PULL: specifies the pull consumption type. -PUSH: specifies the push consumption type. -POP: specifies the pop consumption type. Note: This field may return null, indicating that no valid values can be obtained.
SubString	String	Subscription rule. Note: This field may return null, indicating that no valid values can be obtained.
ExpressionType	String	Filter type. Note: This field may return null, indicating that no valid values can be obtained.
Consistency	Integer	Subscription consistency. enumerated as follows:. -Subscription consistency. -Subscription inconsistency. Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLag	Integer	Consumption heap Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime	Integer	Last consumption progress update time. It is a Unix timestamp (ms). Note: This field may return null, indicating that no valid values can be obtained.
MaxRetryTimes	Integer	Maximum number of retries. Note: This field may return null, indicating that no valid values can be obtained.
ConsumeMessageOrderly	Boolean	Whether it is sequential consumption Note: This field may return null, indicating that no valid values can be obtained.
MessageModel	String	Specifies the consumption mode. BROADCASTING mode. CLUSTERING: cluster mode. Note: This field may return null, indicating that no valid values can be obtained.
ClientSubscriptionInfos	Array of ClientSubscriptionInfo	List of clients with inconsistent subscriptions. Note: This field may return null, indicating that no valid values can be obtained.

Tag

Tag data

Used by actions: CreateConsumerGroup, CreateInstance, DescribeFusionInstanceList, DescribeInstance, DescribeInstanceList, DescribeTopicList.

Name	Type	Required	Description
TagKey	String	Yes	Tag name. Note: This field may return null, indicating that no valid values can be obtained.
TagValue	String	Yes	Tag value Note: This field may return null, indicating that no valid values can be obtained.

TagFilter

Tag filter

Used by actions: DescribeFusionInstanceList, DescribeInstanceList, DescribeTopicList.

Name	Type	Required	Description
TagKey	String	Yes	Tag key name
TagValues	Array of String	Yes	Tag value list

TopicConsumeStats

Topic consumption progress

Used by actions: DescribeConsumerClient.

Name	Type	Description
Topic	String	Topic name
TopicType	String	Topic type. valid values are as follows:. -UNSPECIFIED: unspecified. -NORMAL: standard message. -FIFO: specifies sequential messaging. -DELAY: specifies the delayed message. -Specifies the TRANSACTION message.
QueueNum	Integer	Number of topic queues per node
ConsumerLag	Integer	Consumption heap
SubString	String	Subscription rule. `*` indicates subscription to all topics.
LastUpdateTime	Integer	Last consumption progress update time. It is a Unix timestamp (ms).

TopicItem

Topic information on the list

Used by actions: DescribeTopicList.

Name	Type	Required	Description
InstanceId	String	No	Instance ID
Topic	String	No	Topic name
TopicType	String	No	Topic type. NORMAL: regular message. FIFO: sequential messaging. DELAY: delayed message. TRANSACTION message.
QueueNum	Integer	No	Number of queues
Remark	String	No	Remarks
ClusterIdV4	String	No	Cluster id of version 4.x. Note: This field may return null, indicating that no valid values can be obtained.
NamespaceV4	String	No	Namespace of 4.x. Note: This field may return null, indicating that no valid values can be obtained.
TopicV4	String	No	Topic name for version 4.x. Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4	String	No	Complete namespace for 4.x. Note: This field may return null, indicating that no valid values can be obtained.
MsgTTL	Integer	No	Message retention time.
TagList	Array of Tag	No	List of bound tags

TopicStageChangeResult

Result after modifying the status of the migration topic.

Used by actions: ChangeMigratingTopicToNextStage.

Name	Type	Description
TopicName	String	Topic name
Success	Boolean	Success status
Namespace	String	Namespace. valid only for 4.x.

VpcInfo

VPC information.

Used by actions: CreateInstance.

Name	Type	Required	Description
VpcId	String	Yes	VPC ID
SubnetId	String	Yes	Subnet ID.

ZoneScheduledItem

Whether there are scheduling tasks in each AZ during proxy scheduling.