tencent cloud

Data Types
Last updated: 2025-11-25 10:55:01
Data Types
Last updated: 2025-11-25 10:55:01

BindCluster

Information of dedicated clusters

Used by actions: DescribeBindClusters.

Name Type Description
ClusterName String Name of a physical cluster.

CertificateInfo

Pulsar cluster TLS certificate information.

Used by actions: DescribePulsarProInstances.

Name Type Required Description
CertificateId String Yes Specifies the id in SSL certificate management.
ExpireTime String Yes Certificate expiration time.
DomainName String Yes Specifies the domain name bound to the certificate.
Status String Yes Certificate status: 0 indicates issued.
Expiring soon.
Not activated.
3. indicates expired.
Indicates the unavailability.
Type String Yes Certificate type: 0: root certificate, 1: server certificate.
Origin String Yes TencentCloud: SSL certificate. Default: TDMQ official Default certificate.
ModifyTime String Yes Certificate addition/update time.

ClientSubscriptionInfo

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

Used by actions: DescribeRocketMQTopic, DescribeRocketMQTopics.

Name Type Description
ClientId String Client ID
ClientAddr String Client IP.
Note: This field may return null, indicating that no valid values can be obtained.
Topic String Subscribed topic.
Note: This field may return null, indicating that no valid values can be obtained.
SubString String Subscription expression.
Note: This field may return null, indicating that no valid values can be obtained.
ExpressionType String Subscription method.
Note: This field may return null, indicating that no valid values can be obtained.

Cluster

Set of cluster information

Used by actions: DescribeClusterDetail, DescribeClusters.

Name Type Description
ClusterId String Cluster ID.
ClusterName String Cluster name.
Remark String Remarks.
EndPointNum Integer Number of access points
CreateTime String Creation time
Healthy Integer Whether the cluster is healthy. 1: healthy; 0: exceptional
HealthyInfo String Cluster health information
Note: this field may return null, indicating that no valid values can be obtained.
Status Integer Cluster status. 0: creating; 1: normal; 2: terminating; 3: deleted; 4. isolated; 5. creation failed; 6: deletion failed
MaxNamespaceNum Integer Maximum number of namespaces
MaxTopicNum Integer Maximum number of topics
MaxQps Integer Maximum QPS
MessageRetentionTime Integer Maximum message retention period in seconds
MaxStorageCapacity Integer Maximum storage capacity
Version String Cluster version
Note: this field may return null, indicating that no valid values can be obtained.
PublicEndPoint String Public network access point
Note: this field may return null, indicating that no valid values can be obtained.
VpcEndPoint String VPC access point
Note: this field may return null, indicating that no valid values can be obtained.
NamespaceNum Integer Number of namespaces
Note: this field may return null, indicating that no valid values can be obtained.
UsedStorageBudget Integer Limit of used storage in MB
Note: this field may return null, indicating that no valid values can be obtained.
MaxPublishRateInMessages Integer Maximum message production rate in messages
Note: this field may return null, indicating that no valid values can be obtained.
MaxDispatchRateInMessages Integer Maximum message push rate in messages
Note: this field may return null, indicating that no valid values can be obtained.
MaxPublishRateInBytes Integer Maximum message production rate in bytes
Note: this field may return null, indicating that no valid values can be obtained.
MaxDispatchRateInBytes Integer Maximum message push rate in bytes
Note: this field may return null, indicating that no valid values can be obtained.
TopicNum Integer Number of created topics
Note: this field may return null, indicating that no valid values can be obtained.
MaxMessageDelayInSeconds Integer Maximum message delay in seconds
Note: this field may return null, indicating that no valid values can be obtained.
PublicAccessEnabled Boolean Whether to enable public network access. If this parameter is left empty, the feature will be enabled by default
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tag
Note: this field may return null, indicating that no valid values can be obtained.
PayMode Integer Billing mode:
0: Pay-as-you-go
1: Monthly subscription
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name
Note: This field may return null, indicating that no valid values can be obtained.
UpgradeProInstance Boolean Specifies whether the pro edition instance can be upgraded.

CmqDeadLetterPolicy

cmq DeadLetterPolicy

Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.

Name Type Description
DeadLetterQueue String Dead letter queue.
Policy Integer Dead letter queue policy. 0: maximum number of receipt. 1: maximum unconsumed time.
MaxTimeToLive Integer Maximum unconsumed expiration time. Required if policy is 1. Range: 300-43,200 seconds, must be less than the maximum message retention time MsgRetentionSeconds.
MaxReceiveCount Integer Maximum number of receipt. required when Policy is 0. value range: 1 to 1000.

CmqDeadLetterSource

Cmq DeadLetterSource

Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.

Name Type Description
QueueId String Message queue ID.
Note: this field may return null, indicating that no valid values can be obtained.
QueueName String Message queue name.

CmqQueue

Batch queue attribute information of CMQ

Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.

Name Type Description
QueueId String Message queue ID.
QueueName String Message queue name.
Qps Integer Limit on the number of messages produced per second. The size of consumed messages is 1.1 times this value.
Bps Integer Bandwidth limit.
MaxDelaySeconds Integer Specifies the maximum retention time for in-flight messages, which must be less than the message retention period.
MaxMsgHeapNum Integer Maximum number of heaped messages. The value range is 1,000,000–10,000,000 during the beta test and can be 1,000,000–1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released.
PollingWaitSeconds Integer Long polling waiting time for message receipt. Value range 0-30 seconds, default value 0.
MsgRetentionSeconds Integer Message retention period. The value range is 60-1,296,000 seconds (1 min-15 days), with a default value of 345,600 seconds (4 days).
VisibilityTimeout Integer Message visibility timeout period. The value range is 1-43,200 seconds (within 12 hours), with a default value of 30.
MaxMsgSize Integer Maximum message length. Range: 1,024-1,048,576 bytes (i.e., 1K-1,024K). Default value is 65,536.
RewindSeconds Integer Maximum message backtracking time for backtracking queues, range 0-43,200 seconds. 0 means message backtracking is not enabled.
CreateTime Integer Creation time of queues. Returns a Unix timestamp, accurate to milliseconds.
LastModifyTime Integer The last time the queue attribute was modified. Returns a Unix timestamp, accurate to milliseconds.
ActiveMsgNum Integer Total number of active messages (not being consumed) in queue, an approximate value.
InactiveMsgNum Integer Total number of inactive messages (being consumed) in queue, an approximate value.
DelayMsgNum Integer Number of delayed messages.
Note: this field may return null, indicating that no valid values can be obtained.
RewindMsgNum Integer Number of retained messages which have been deleted by the DelMsg API but are still within their rewind time range.
Note: this field may return null, indicating that no valid values can be obtained.
MinMsgTime Integer Minimum unconsumed time of message in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
Transaction Boolean Transaction message queue. true: transaction message type; false: other message types.
Note: this field may return null, indicating that no valid values can be obtained.
DeadLetterSource Array of CmqDeadLetterSource Dead letter queue.
Note: this field may return null, indicating that no valid values can be obtained.
DeadLetterPolicy CmqDeadLetterPolicy Dead letter queue policy.
Note: this field may return null, indicating that no valid values can be obtained.
TransactionPolicy CmqTransactionPolicy Transaction message policy.
Note: this field may return null, indicating that no valid values can be obtained.
CreateUin Integer Creator Uin.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Associated tag.
Note: this field may return null, indicating that no valid values can be obtained.
Trace Boolean Message trace. true: enabled; false: not enabled
Note: this field may return null, indicating that no valid values can be obtained.
TenantId String Tenant ID
NamespaceName String Specifies the namespace name.
Status Integer Cluster status. 0: Creating, 1: Normal, 2: Deleting, 3: Deleted, 4: Isolating, 5: Creation failed, 6: Deletion failed
MaxUnackedMsgNum Integer Maximum Number of Unacknowledged Messages
MaxMsgBacklogSize Integer Maximum Message Backlog Size (bytes)
RetentionSizeInMB Integer Queue retrospective storage space. Value range: 1024 MB to 10240 MB. 0 indicates disabled.

CmqSubscription

Subscription response parameter in CMQ

Used by actions: DescribeCmqSubscriptionDetail.

Name Type Description
SubscriptionName String Subscription name, which must be unique under the same account and same topic in a single region. the name is a string of no more than 64 characters, beginning with a letter, and the remaining part may contain letters, numbers, and hyphens (-).
SubscriptionId String Subscription ID. The subscription ID is used when monitoring data is pulled.
TopicOwner Integer Subscription owner APPID.
Note: this field may return null, indicating that no valid values can be obtained.
MsgCount Integer The number of messages waiting for shipping for this subscription.
LastModifyTime Integer The last time the subscription attribute was modified. Returns a Unix timestamp, accurate to milliseconds.
CreateTime Integer The time when the subscription was created. Returns a Unix timestamp, accurate to milliseconds.
BindingKey Array of String Filtering policy for subscribing to and receiving messages.
Note: this field may return null, indicating that no valid values can be obtained.
Endpoint String The endpoint that receives notifications is differentiated by protocol: For HTTP, the endpoint must start with http://, and the host can be a domain name or IP; for queue, fill in queueName.
FilterTags Array of String Describes the filtering policy selected by users when creating subscriptions.
filterType = 1 indicates Tag filtering when users use filterTag.
filterType = 2 indicates user use bindingKey for filtering.
Protocol String The subscription protocol, currently supports two protocols: HTTP and queue. When the HTTP protocol is used, users need to set up their own web server to accept messages. When the queue protocol is used, messages will automatically be pushed to CMQ queues, and users can pull messages concurrently.
NotifyStrategy String Specifies the CMQ push server retry policy when an error occurs while pushing messages to an endpoint. valid values:.
BACKOFF_RETRY, backoff retry. retry at regular intervals, discard the message after a certain number of retries, and continue to push the next message.
(2) EXPONENTIAL_DECAY_RETRY, EXPONENTIAL DECAY RETRY. the interval between retries increases exponentially, for example starting at 1s, followed by 2s, 4s, 8s... since the Topic message period is one day, RETRY for at most one day then discard the message. default value is EXPONENTIAL_DECAY_RETRY.
NotifyContentFormat String The format of the push content. Values: (1) JSON; (2) SIMPLIFIED, i.e., raw format. If protocol is queue, the value must be SIMPLIFIED. If protocol is HTTP, both values are acceptable, with the default being JSON.
TopicName String Topic Name of the Subscription

CmqTopic

Display field of the returned CMQ topic information

Used by actions: DescribeCmqTopicDetail, DescribeCmqTopics.

Name Type Required Description
TopicId String No Topic ID.
TopicName String No Topic name.
MsgRetentionSeconds Integer No Maximum lifetime of messages in a topic. After the time specified by this parameter has elapsed since sending to this topic, the message will be deleted whether or not it has been successfully pushed to the user. Measured in seconds and fixed at one day (86,400 seconds). This attribute cannot be modified.
MaxMsgSize Integer No Maximum message length. value range: 1024-1048576 bytes (1-1024 kb). default value: 1048576.
Qps Integer No Number of messages published per second.
FilterType Integer No Describes the filtering policy selected by users when creating subscriptions.
FilterType = 1 means when users use Tag filtering with FilterTag.
FilterType = 2 indicates user use BindingKey for filtering.
CreateTime Integer No Topic creation time. Returns a Unix timestamp, accurate to milliseconds.
LastModifyTime Integer No The last time the topic attribute was modified. Returns a Unix timestamp, accurate to milliseconds.
MsgCount Integer No Number of messages in the current topic (message backlog).
CreateUin Integer No Creator Uin. The resource field for CAM authentication is composed of this field.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag No Associated tag.
Note: this field may return null, indicating that no valid values can be obtained.
Trace Boolean No Message trace. true: enabled; false: not enabled
Note: this field may return null, indicating that no valid values can be obtained.
TenantId String No Tenant ID
NamespaceName String No Specifies the namespace name.
Status Integer No Cluster status. 0: Creating, 1: Normal, 2: Deleting, 3: Deleted, 4: Isolating, 5: Creation failed, 6: Deletion failed
BrokerType Integer No 0: Pulsar, 1: RocketMQ
SubscriptionCount Integer No Number of Subscriptions

CmqTransactionPolicy

cmq TransactionPolicy

Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.

Name Type Description
FirstQueryInterval Integer First recheck time.
MaxQueryCount Integer Maximum query times.

Consumer

Consumer.

Used by actions: DescribeSubscriptions.

Name Type Description
ConnectedSince String The time when the consumer started connecting.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerAddr String Consumer address.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerName String Consumer name.
Note: This field may return null, indicating that no valid values can be obtained.
ClientVersion String Consumer version.
Note: This field may return null, indicating that no valid values can be obtained.
Partition Integer Serial number of the topic partition connected to the consumer.
Note: This field may return null, indicating that no valid values can be obtained.

ConsumerLog

Consumption log

Used by actions: DescribeMsgTrace.

Name Type Description
MsgId String Message ID.
ConsumerGroup String Consumption group.
ConsumerName String Consumer name.
ConsumeTime String Consumption time.
ConsumerAddr String Consumer client address.
ConsumeUseTime Integer Consumption time (milliseconds).
Status String Consumption status.

ConsumerLogs

Consumption information

Used by actions: DescribeMsgTrace.

Name Type Description
TotalCount Integer Record count.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLogSets Array of ConsumerLog Consumption log.
Note: This field may return null, indicating that no valid values can be obtained.

ConsumersSchedule

Consumption progress details

Used by actions: DescribeSubscriptions.

Name Type Description
Partitions Integer ID of the current partition.
Note: This field may return null, indicating that no valid values can be obtained.
NumberOfEntries Integer The number of messages.
Note: This field may return null, indicating that no valid values can be obtained.
MsgBacklog Integer The number of heaped messages.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateOut String The total number of messages delivered by the consumer per second.
MsgThroughputOut String The size (in bytes) of messages consumed by the consumer per second.
MsgRateExpired String Percentage of messages discarded due to timeout.
Note: This field may return null, indicating that no valid values can be obtained.

DetailedRolePerm

Permission configuration in the topic/group dimension.

Used by actions: CreateRocketMQEnvironmentRole, ModifyRocketMQEnvironmentRole.

Name Type Required Description
Resource String Yes Resources corresponding to permissions.
PermWrite Boolean Yes Whether to enable production permission
PermRead Boolean Yes Whether to enable consumption permission
ResourceType String Yes Authorized resource type (Topic: topic; Group: consumer group).
Remark String No Resource remarks.

DimensionInstance

Array of instance dimension combinations

Used by actions: DescribeRocketMQTopUsages.

Name Type Required Description
Dimensions Array of DimensionOpt Yes Dimension Combination of Instance
Note: This field may return null, indicating that no valid values can be obtained.

DimensionOpt

Metric Dimension Object

Used by actions: DescribeRocketMQTopUsages.

Name Type Required Description
Name String Yes Queried dimension name
Note: This field may return null, indicating that no valid values can be obtained.
Value String Yes Queried Dimension Value
Note: This field may return null, indicating that no valid values can be obtained.

Environment

Namespace information

Used by actions: DescribeEnvironments.

Name Type Description
EnvironmentId String Namespace name.
Remark String Description.
MsgTTL Integer Retention period for unconsumed messages in seconds. Maximum value: 1,296,000 seconds (15 days).
CreateTime Timestamp Creation time.
UpdateTime Timestamp Last modified.
NamespaceId String Namespace ID.
NamespaceName String Namespace name.
TopicNum Integer The number of topics.
Note: This field may return null, indicating that no valid values can be obtained.
RetentionPolicy RetentionPolicy Message retention policy.
Note: This field may return null, indicating that no valid values can be obtained.
AutoSubscriptionCreation Boolean Whether to enable "Auto-Create Subscription"
Note: This field may return null, indicating that no valid values can be obtained.

EnvironmentRole

Set of environment roles

Used by actions: DescribeEnvironmentRoles, DescribeRocketMQEnvironmentRoles.

Name Type Description
EnvironmentId String Environment (namespace).
RoleName String Role name.
Permissions Array of String Permissions, which is a non-empty string array of produce and consume at the most.
RoleDescribe String Role description.
CreateTime Timestamp Creation time.
UpdateTime Timestamp Update time.

EnvironmentRoleSet

Relationship between the namespaces that are bound in batches and role permissions

Used by actions: CreateRole, ModifyRole.

Name Type Required Description
EnvironmentId String Yes The IDs of the bound namespaces cannot be delicate and the namespaces must contain resources
Note: This field may return null, indicating that no valid values can be obtained.
Permissions Array of String Yes Permissions to be bound to a namespace. Enumerated values: consume, produce, and consume, produce. This parameter cannot be left empty.

Note: This field may return null, indicating that no valid values can be obtained.

ExchangeQuota

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
MaxExchange Integer
UsedExchange Integer Number of created exchanges.

Filter

Filter parameter

Used by actions: DescribeClusters, DescribeCmqQueues, DescribeCmqTopics, DescribeEnvironmentRoles, DescribeEnvironments, DescribePublishers, DescribePulsarProInstances, DescribeRabbitMQNodeList, DescribeRabbitMQVipInstances, DescribeRabbitMQVirtualHost, DescribeRocketMQClusters, DescribeRocketMQEnvironmentRoles, DescribeRocketMQProducers, DescribeRocketMQRoles, DescribeRocketMQVipInstances, DescribeRoles, DescribeTopics.

Name Type Required Description
Name String No Filter parameter name
Values Array of String No Value

FilterSubscription

Filter subscriptions

Used by actions: DescribeSubscriptions.

Name Type Required Description
ConsumerHasCount Boolean No Whether to only display subscriptions that include real consumers.
ConsumerHasBacklog Boolean No Whether to only display subscriptions with heaped messages.
ConsumerHasExpired Boolean No Whether to only display subscriptions with messages discarded after expiration.
SubscriptionNames Array of String No Filter by subscription name for exact query.

InstanceNodeDistribution

Information of instance node distribution

Used by actions: DescribePulsarProInstanceDetail, DescribeRocketMQVipInstanceDetail.

Name Type Description
ZoneName String AZ
ZoneId String AZ ID
NodeCount Integer Number of nodes
NodePermWipeFlag Boolean This flag is true if there is a scheduling task with no switchback AZs.
ZoneStatus String Availability zone status
Note: This field may return null, indicating that no valid values can be obtained.

MsgLog

Message log

Used by actions: DescribeTopicMsgs.

Name Type Description
MsgId String Message ID.
ProducerName String Producer name.
ProduceTime String Production time.
ProducerAddr String Producer client address.

PartitionsTopic

Partitioned topic

Used by actions: DescribeTopics.

Name Type Description
AverageMsgSize String Average size of the messages published in the last interval in bytes.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerCount String The number of consumers.
Note: This field may return null, indicating that no valid values can be obtained.
LastConfirmedEntry String The total number of recorded messages.
Note: This field may return null, indicating that no valid values can be obtained.
LastLedgerCreatedTimestamp String Time when the last ledger was created.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateIn String The number of messages published by local and replicated publishers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateOut String The total number of messages delivered by local and replicated consumers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgThroughputIn String The size (in bytes) of messages published by local and replicated publishers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgThroughputOut String The size (in bytes) of messages delivered by local and replicated consumers per second.
Note: This field may return null, indicating that no valid values can be obtained.
NumberOfEntries String The total number of recorded messages.
Note: This field may return null, indicating that no valid values can be obtained.
Partitions Integer Subpartition ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProducerCount String The number of producers.
Note: This field may return null, indicating that no valid values can be obtained.
TotalSize String Total size of all stored messages in bytes.
Note: This field may return null, indicating that no valid values can be obtained.
TopicType Integer Topic type description.
Note: This field may return null, indicating that no valid values can be obtained.

ProducerInfo

Producer client details.

Used by actions: DescribeRocketMQProducers.

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 Specifies the 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.
Note: This field may return null, indicating that no valid values can be obtained.

ProducerLog

Message production information

Used by actions: DescribeMsgTrace.

Name Type Description
MsgId String Message ID.
ProducerName String Producer name.
ProduceTime String Message production time.
ProducerAddr String Producer client.
ProduceUseTime Integer Production time cost (in seconds).
Status String Status.

PrometheusEndpointInfo

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
PrometheusEndpointStatus String
VpcPrometheusEndpoint Array of String
NodePrometheusAddress Array of String
VpcEndpointInfo VpcEndpointInfo

PublicAccessRule

Public Network Access Security Rules

Used by actions: CreateRocketMQVipInstance, DescribeRocketMQPublicAccessPoint, SetRocketMQPublicAccessPoint.

Name Type Required Description
IpRule String Yes IP Subnet Information
Allow Boolean Yes Allow or Deny
Remark String No Remarks
Note: This field may return null, indicating that no valid values can be obtained.

Publisher

Producer information

Used by actions: DescribePublishers.

Name Type Description
ProducerId Integer Producer ID.
Note: this field may return null, indicating that no valid values can be obtained.
ProducerName String Producer name.
Note: this field may return null, indicating that no valid values can be obtained.
Address String Producer address.
Note: this field may return null, indicating that no valid values can be obtained.
ClientVersion String Client version.
Note: this field may return null, indicating that no valid values can be obtained.
MsgRateIn Float Message production rate (message/sec).
Note: this field may return null, indicating that no valid values can be obtained.
MsgThroughputIn Float Message production throughput rate (byte/sec).
Note: this field may return null, indicating that no valid values can be obtained.
AverageMsgSize Float Average message size in bytes.
Note: this field may return null, indicating that no valid values can be obtained.
ConnectedSince String Connection time.
Note: this field may return null, indicating that no valid values can be obtained.
Partition Integer Serial number of the topic partition connected to the producer.
Note: this field may return null, indicating that no valid values can be obtained.

PulsarNetworkAccessPointInfo

TDMQ for Pulsar network access point information

Used by actions: DescribePulsarProInstanceDetail.

Name Type Description
VpcId String VPC ID. This field is left empty for supporting network and public network access points.
Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String Subnet ID. This field is left empty for supporting network and public network access points.
Note: This field may return null, indicating that no valid values can be obtained.
Endpoint String Access address
InstanceId String Instance ID
RouteType Integer Access point type:
0: Supporting network access point
1: VPC access point
2: Public network access point
OperationType Integer 0: local region access. since cross-region disaster recovery is not configured, this type of access point cannot perform cross-region switchover or switch back from remote access.
Local region access. due to the configuration of cross-region disaster recovery, switchover can be performed at any time in a different location. this state is used for the primary cluster access point.
Cross-Region access, completed offsite switchover, this state is used for the access point of the source cluster. the access point in this state is non-deletable.
3: cross-region access can be switched back from remote access at any time. this state is for the access point of the target cluster. the access point in this state is non-deletable.
Cross-Region access. the target cluster has completed offsite switchback and is in the state of waiting for deletion.
Note: This field may return null, indicating that no valid values can be obtained.
AccessPointsType String Access point type.
Note: This field may return null, indicating that no valid values can be obtained.
Bandwidth Integer Bandwidth. currently only public network has this value.
Note: This field may return null, indicating that no valid values can be obtained.
SecurityPolicy Array of SecurityPolicy Class.
Note: This field may return null, indicating that no valid values can be obtained.
StandardAccessPoint Boolean Indicates whether it is a standard access point. valid values: true (standard), false (not standard).
Note: This field may return null, indicating that no valid values can be obtained.
ZoneName String AZ information
Note: This field may return null, indicating that no valid values can be obtained.
Tls Boolean Specifies whether TLS encryption is enabled.
CustomUrl String Access point custom domain name.

PulsarProClusterInfo

TDMQ for Pulsar pro cluster information

Used by actions: DescribePulsarProInstanceDetail.

Name Type Description
ClusterId String Cluster ID
ClusterName String Cluster name
Remark String Description
CreateTime String Creation time
Status Integer Cluster status. Valid values: 0 (Creating), 1 (Normal), 2 (Isolated).
Version String Cluster version
NodeDistribution Array of InstanceNodeDistribution Node distribution
Note: This field may return null, indicating that no valid values can be obtained.
MaxStorage Integer Max storage capacity in MB
CanEditRoute Boolean Whether the route can be modified
Note: This field may return null, indicating that no valid values can be obtained.
BillingLabelVersion String Specifies different billing specifications for pro edition and small-scale professional edition: PULSAR.P1 fixed storage and PULSAR.P2 elastic storage.
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Instance expiration timestamp, accurate to the millisecond level.
Note: This field may return null, indicating that no valid values can be obtained.
AutoCreateTopicStatus Boolean Whether to enable automatic topic creation.
true indicates enabled. false indicates disabled.
Note: This field may return null, indicating that no valid values can be obtained.
DefaultPartitionNumber Integer Specifies the default number of partitions for automatic topic creation. valid values: 0 if not enabled.
Note: This field may return null, indicating that no valid values can be obtained.
Tenant String User-Defined tenant alias. if there is no, reuse the professional cluster ID.
DeleteProtection Integer Deletion protection switch flag.

PulsarProClusterSpecInfo

TDMQ for Pulsar pro cluster specification information

Used by actions: DescribePulsarProInstanceDetail.

Name Type Description
SpecName String Cluster specification name
MaxTps Integer Peak TPS
MaxBandWidth Integer Peak bandwidth in Mbps
MaxNamespaces Integer Maximum number of namespaces
MaxTopics Integer Maximum number of topic partitions
ScalableTps Integer Elastic TPS beyond the specification
Note: This field may return null, indicating that no valid values can be obtained.
MaxPartitions Integer 32 or 128.
Maximum number of partitions for topics in the current cluster.
Note: This field may return null, indicating that no valid values can be obtained.
MaxDelayedMessages Integer Maximum delayed message count for the product. 0 indicates no limit.

PulsarProInstance

TDMQ for Pulsar pro instance information

Used by actions: DescribePulsarProInstances.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceVersion String Instance version
Status Integer Instance status. Valid values: 0 (Creating), 1 (Normal), 2 (Isolated), 3 (Terminated), 4 (Abnormal), 5 (Delivery failed), 6 (Adjusting configuration), 7 (Configuration adjustment failed).
ConfigDisplay String Instance specification name
MaxTps Integer Peak TPS
MaxStorage Integer Storage capacity in GB
ExpireTime Integer Instance expiration time in milliseconds
AutoRenewFlag Integer Renewal mode. Valid values: 0 (Manual renewal, which is the default mode), 1 (Auto-renewal), 2 (Manual renewal, which is specified by users).
PayMode Integer Payment mode. Valid values: 0 (Pay-as-you-go), 1 (Monthly subscription).
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.
SpecName String Instance specification ID
ScalableTps Integer Elastic TPS beyond the specification
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 Subnet ID
Note: This field may return null, indicating that no valid values can be obtained.
MaxBandWidth Integer Peak bandwidth in Mbps
Tags Array of Tag Tag list of the cluster
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Cluster Creation Time
Note: This field may return null, indicating that no valid values can be obtained.
BillingLabelVersion String Specifies the different billing specifications for pro edition and small-scale professional edition: PULSAR.P1 fixed storage and PULSAR.P2 elastic storage.
Note: This field may return null, indicating that no valid values can be obtained.
Tenant String Custom tenant.
CertificateList Array of CertificateInfo Certificate list of the cluster.

QueueQuota

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
MaxQueue Integer
UsedQueue Integer Number of created Queues.

RabbitMQBindingListInfo

RabbitMQ routing relationship list member.

Used by actions: DescribeRabbitMQBindings.

Name Type Description
BindingId Integer Routing relationship ID.
VirtualHost String VhostName
Source String Source exchange name.
DestinationType String Destination type. Valid values: queue and exchange.
Destination String Destination resource name.
RoutingKey String Binds the key.
SourceExchangeType String Source exchange type.
CreateTime String Creation time.
ModifyTime String Modification time.
CreateTs Integer Creation timestamp.
ModifyTs Integer Modification timestamp.

RabbitMQClusterAccessInfo

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
PublicAccessEndpoint String
WebConsoleEndpoint String
WebConsoleUsername String
WebConsolePassword String
PublicAccessEndpointStatus Boolean
PublicControlConsoleSwitchStatus Boolean
VpcControlConsoleSwitchStatus Boolean
VpcWebConsoleEndpoint String
PublicWebConsoleSwitchStatus String Status of the public network access point in the console. Valid values: OFF, ON, CREATING, and DELETING.
VpcWebConsoleSwitchStatus String Vpc console switch state. example value.
OFF/ON/CREATING/DELETING
PublicDataStreamStatus String Status of the public network access point in the console. Valid values: OFF, ON, CREATING, and DELETING.
PrometheusEndpointInfo PrometheusEndpointInfo Prometheus information.
WebConsoleDomainEndpoint String Public domain name access point.
ControlPlaneEndpointInfo VpcEndpointInfo VPC information used by the control plane.
PublicTlsAccessEndpoint String Encrypted TLS data stream public network access point.
PublicIpReused Boolean Specifies whether to reuse the public IP address.

RabbitMQClusterInfo

RabbitMQ cluster basic information.

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
ClusterId String Cluster ID
ClusterName String
Region String
CreateTime Integer Creation time in milliseconds. unix timestamp.
Remark String Cluster description information
Vpcs Array of VpcEndpointInfo
ZoneIds Array of Integer AZ information
VirtualHostNumber Integer
QueueNumber Integer
MessagePublishRate Float
MessageStackNumber Integer
ExpireTime Integer Specifies the instance expiration time in milliseconds as a unix timestamp. the value is 0 for pay-as-you-go resources.
ChannelNumber Integer
ConnectionNumber Integer
ConsumerNumber Integer
ExchangeNumber Integer
ExceptionInformation String Cluster exception information.
Note: This field may return null, indicating that no valid values can be obtained.
ClusterStatus Integer Instance status. 0: creating; 1: normal; 2: isolating; 3: terminated; 4: abnormal; 5: delivery failed.
AutoRenewFlag Integer Auto-renewal flag. 0 indicates the default status (If the default status is not configured, manual renewal is enabled), 1 indicates auto-renewal, and 2 indicates explicitly no auto-renewal (configured by the user).
MirrorQueuePolicyFlag Integer Whether the image queue policy is enabled. 1: enabled; 0: disabled.
MessageConsumeRate Float Number of messages consumed per second. Unit: messages/second.
ClusterVersion String Cluster version information.
PayMode Integer Billing mode. 0: postpaid; 1: prepaid.
InstanceType Integer Instance type. 0: Exclusive Edition; 1: Serverless Edition.
IsolatedTime Integer Specifies the isolation time started. unix timestamp.
Container Boolean Whether it is a container instance. default true.
Tags Array of Tag Tag list
EnableDeletionProtection Boolean Whether deletion protection is enabled.

RabbitMQClusterSpecInfo

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
SpecName String
NodeCount Integer
MaxTps Integer
MaxBandWidth Integer
MaxStorage Integer
PublicNetworkTps Integer

RabbitMQClusterWhiteListInfo

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
WhiteList String Deprecated.
PublicControlConsoleWhiteList String Public network console allowlist.
PublicDataStreamWhiteList String Public network data flow allowlist.
PublicControlConsoleWhiteListStatus String
PublicDataStreamWhiteListStatus String

RabbitMQExchangeListInfo

RabbitMQ exchange list member information

Used by actions: DescribeRabbitMQExchanges.

Name Type Description
ExchangeName String Exchange name.
Remark String Remarks

Note: this field may return null, indicating that no valid values can be obtained.
ExchangeType String Exchange type. Valid values: "fanout", "direct", "topic", "headers".
VirtualHost String Specifies the Host name of the Virtual switch.
ExchangeCreator String Exchange creator. "system": "created by the system"; "user": "created by a user".
CreateTimeStamp String Exchange creation time.
ModTimeStamp String Exchange modification time.
MessageRateIn Float Input message rate.
Note: this field may return null, indicating that no valid values can be obtained.
MessageRateOut Float Indicates the output message rate.
Note: this field may return null, indicating that no valid values can be obtained.
Durable Boolean Whether the exchange is a durable one. true: durable; false: non-durable.
AutoDelete Boolean Whether automatic deletion is set for the exchange. true: automatic deletion set; false: automatic deletion not set.
Internal Boolean Whether the exchange is an internal one. true: internal exchange.
InstanceId String Instance ID of the exchange.
Policy String Effective policy name.
Note: this field may return null, indicating that no valid values can be obtained.
Arguments String Extended parameters of the key-value object type.
MessagesDelayed Integer Number of unscheduled delayed messages.
Note: this field may return null, indicating that no valid values can be obtained.
CreateTs Integer Creation time timestamp.
ModifyTs Integer Modification time timestamp.

RabbitMQPermission

RabbitMQ permission details

Used by actions: DescribeRabbitMQPermission.

Name Type Description
InstanceId String Instance ID, such as amqp-xxxxxxxx. effective InstanceId can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1).
User String Username, such as admin. effective User names can be found by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1), clicking a cluster in the cluster list, entering cluster details, and locating the list of users under the User and permission management tab, thereby finding the username.
VirtualHost String VirtualHost name, such as testvhost. valid VirtualHost names can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1), clicking Vhost in the left sidebar, and finding the Vhost name in the Vhost list.
ConfigRegexp String Type of permissions related to declare operations. This regular expression controls resource creation and deletion permissions of users in this vhost.
WriteRegexp String Type of permissions related to message write operations. This regular expression controls resource creation and deletion permissions of users in this vhost.
ReadRegexp String Type of permissions related to message read operations. This regular expression controls resource creation and deletion permissions of users in this vhost.
CreateTime String Creation time.
ModifyTime String Modification time.
CreateTs Integer Creation timestamp.
ModifyTs Integer Modification timestamp.

RabbitMQPrivateNode

RabbitMQ node information.

Used by actions: DescribeRabbitMQNodeList.

Name Type Description
NodeName String Node name
Note: This field may return null, indicating that no valid value can be obtained.
NodeStatus String Node status. running indicates the node is active. down indicates an exception.
Note: This field may return null, indicating that no valid values can be obtained.
CPUUsage String CPU utilization
Note: This field may return null, indicating that no valid values can be obtained.
Memory Integer Memory usage in MB
Note: This field may return null, indicating that no valid values can be obtained.
DiskUsage String Disk utilization
Note: This field may return null, indicating that no valid values can be obtained.
ProcessNumber Integer The number of RabbitMQ Erlang processes
Note: This field may return null, indicating that no valid values can be obtained.

RabbitMQQueueListConsumerDetailInfo

RabbitMQ queue list consumer info

Used by actions: DescribeRabbitMQQueues.

Name Type Description
ConsumersNumber Integer Consumer count.
Note: this field may return null, indicating that no valid values can be obtained.

RabbitMQQueueListInfo

RabbitMQ queue list member information.

Used by actions: DescribeRabbitMQQueues.

Name Type Description
QueueName String Queue name
Remark String Remarks

Note: this field may return null, indicating that no valid values can be obtained.
ConsumerDetail RabbitMQQueueListConsumerDetailInfo Consumer information.
QueueType String Queue type. Valid values: "classic" and "quorum".
MessageHeapCount Integer Number of retained messages

Note: this field may return null, indicating that no valid values can be obtained.
MessageRateIn Float Message production rate per second.
Note: this field may return null, indicating that no valid values can be obtained.
MessageRateOut Float Message consumption rate per second.
Note: this field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time.
ModifyTime String Modification time.
Durable Boolean Whether the queue is durable. true: durable; false: non-durable.
AutoDelete Boolean Whether automatic deletion is set for the queue. true: automatic deletion set; false: automatic deletion not set.
InstanceId String Instance ID of the queue.
VirtualHost String Vhost name of the queue.
Node String Primary node name of the queue.
Policy String Indicates the name of the effective policy.
Note: this field may return null, indicating that no valid values can be obtained.
Arguments String Extended parameters of the key-value object type.
Exclusive Boolean Whether the queue is exclusive.
CreateTs Integer Creation time timestamp.
ModifyTs Integer Modification time timestamp.

RabbitMQUser

TDMQ for RabbitMQ user entity details

Used by actions: DescribeRabbitMQUser.

Name Type Description
InstanceId String Instance ID, such as amqp-xxxxxxxx. effective InstanceId can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1).
User String Username, which is used for login.
Password String Password, which is used for login.
Description String User description
Tags Array of String User tags, which determine the scope of permissions of this user to access RabbitMQ Management.
CreateTime String User creation time
ModifyTime String Last user modification time
Type String User type. Valid values: System (Created by system), User (Created by user).
MaxConnections Integer Maximum number of available connections per user.
Note: This field may return null, indicating that no valid values can be obtained.
MaxChannels Integer Maximum number of available channels per user.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTs Integer Creation timestamp.
ModifyTs Integer Modification timestamp.

RabbitMQUserQuota

RabbitMQ instance user quota information.

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
MaxUser Integer Maximum creation number of users.
UsedUser Integer Indicates the number of users in use.

RabbitMQVipInstance

RabbitMQ managed instance information.

Used by actions: DescribeRabbitMQVipInstances.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceVersion String Instance version.
Status Integer Instance status. Valid values: 0 (Creating), 1 (Normal), 2 (Isolated), 3 (Terminated), 4 (Abnormal), 5 (Delivery failed).
NodeCount Integer Number of nodes
ConfigDisplay String Instance specification name
MaxTps Integer Peak TPS
MaxBandWidth Integer Peak bandwidth in Mbps
MaxStorage Integer Storage capacity in GB
ExpireTime Integer Specifies the instance expiration time in milliseconds as a unix timestamp. the value is 0 for pay-as-you-go resources.
AutoRenewFlag Integer Renewal mode. Valid values: 0 (Manual renewal, which is the default mode), 1 (Auto-renewal), 2 (Manual renewal, which is specified by users).
PayMode Integer 1 indicates prepaid mode, 0 indicates postpaid.
Remark String Remarks
SpecName String Node specification of the cluster. specifies the corresponding flag.
2C8G:rabbit-vip-profession-2c8g
4C16G:rabbit-vip-profession-4c16g
8C32G:rabbit-vip-profession-8c32g
16C32G:rabbit-vip-basic-4
16C64G:rabbit-vip-profession-16c64g
2C4G:rabbit-vip-basic-5
4C8G:rabbit-vip-basic-1
8C16G (sold out): rabbit-vip-basic-2.
Specifies the default value as 4C8G: rabbit-vip-basic-1.
ExceptionInformation String Cluster exception information.
Note: This field may return null, indicating that no valid values can be obtained.
ClusterStatus Integer Instance status. Valid values: 0 (Creating), 1 (Normal), 2 (Isolated), 3 (Terminated), 4 (Abnormal), 5 (Delivery failed).
This parameter is used to display the instance status additionally and distinguish from the Status parameter.
PublicAccessEndpoint String Public network access point.
Note: This field may return null, indicating that no valid values can be obtained.
Vpcs Array of VpcEndpointInfo VPC access point list.
CreateTime Integer Creation time in milliseconds. unix timestamp.
InstanceType Integer Instance type. valid values: 0 (managed), 1 (Serverless).
IsolatedTime Integer Isolation time, in milliseconds. unix timestamp.
EnableDeletionProtection Boolean Whether deletion protection is enabled.
Tags Array of Tag Tag list

RabbitMQVirtualHostInfo

TDMQ for RabbitMQ vhost details

Used by actions: DescribeRabbitMQVirtualHost.

Name Type Description
InstanceId String Cluster instance ID
VirtualHost String Vhost name
Description String Vhost description information.
Tags Array of String Vhost tags.
CreateTime String Creation time.
ModifyTime String Modification time.
VirtualHostStatistics RabbitMQVirtualHostStatistics Vhost overview statistics information.
TraceFlag Boolean Message trace enabling status. true: enabled; false: disabled.
Status String Vhost status, which corresponds to status in the native product console. Valid values: running, partial, stopped, and unknown.
MessageHeapCount Integer Message backlog count.
MessageRateIn Float Message input rate.
MessageRateOut Float Message output rate.
MirrorQueuePolicyFlag Boolean Whether an image queue policy exists. true: Exists; false: Does not exist.
CreateTs Integer Creation timestamp.
ModifyTs Integer Modification timestamp.

RabbitMQVirtualHostStatistics

Statistics of vhost overview

Used by actions: DescribeRabbitMQVirtualHost.

Name Type Description
CurrentQueues Integer The number of queues in the current vhost
CurrentExchanges Integer The number of exchanges in the current vhost
CurrentConnections Integer The number of connections in the current vhost
CurrentChannels Integer The number of channels in the current vhost
CurrentUsers Integer The number of users in the current vhost

RetentionPolicy

Message retention policy

Used by actions: CreateEnvironment, DescribeEnvironments, ModifyEnvironmentAttributes.

Name Type Required Description
TimeInMinutes Integer Yes Message retention period
SizeInMB Integer Yes Message retention size

RocketMQClusterConfig

RocketMQ cluster configuration

Used by actions: DescribeRocketMQCluster, DescribeRocketMQClusters.

Name Type Description
MaxNamespaceNum Integer Maximum number of namespaces
UsedNamespaceNum Integer Number of used namespaces
MaxTopicNum Integer Maximum number of topics
UsedTopicNum Integer Number of used topics
MaxGroupNum Integer Maximum number of groups
UsedGroupNum Integer Number of used groups
MaxRetentionTime Integer Maximum message retention period in milliseconds
MaxLatencyTime Integer Maximum message delay in milliseconds
MaxQueuesPerTopic Integer The maximum number of queues in a single topic
Note: This field may return null, indicating that no valid values can be obtained.
TopicDistribution Array of RocketMQTopicDistribution Topic distribution.
Note: This field may return null, indicating that no valid values can be obtained.
MaxRoleNum Integer Maximum number of roles.
MaxTpsLimit Integer TPS quota.

RocketMQClusterDetail

Details of the tenant’s RocketMQ cluster

Used by actions: DescribeRocketMQClusters.

Name Type Description
Info RocketMQClusterInfo Basic cluster information.
Config RocketMQClusterConfig Cluster configuration information.
Status Integer Cluster status. 0: Creating; 1: Normal; 2: Terminating; 3: Deleted; 4. Isolated; 5. Creation failed; 6: Deletion failed.
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQClusterInfo

RocketMQ cluster's basic information

Used by actions: DescribeRocketMQCluster, DescribeRocketMQClusters, DescribeRocketMQVipInstanceDetail.

Name Type Description
ClusterId String Cluster ID
ClusterName String Cluster name
Region String Region information
CreateTime Integer Creation time in milliseconds
Remark String Cluster remarks
Note: this field may return null, indicating that no valid values can be obtained.
PublicEndPoint String Public network access address
VpcEndPoint String VPC access address
SupportNamespaceEndpoint Boolean Whether the namespace access point is supported.
Note: This field may return null, indicating that no valid values can be obtained.
Vpcs Array of VpcConfig VPC Information
Note: This field may return null, indicating that no valid values can be obtained.
IsVip Boolean Whether it is an exclusive instance
Note: This field may return null, indicating that no valid values can be obtained.
RocketMQFlag Boolean TDMQ for RocketMQ cluster type flag
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Billing status (1: Normal; 2: Service suspended; 3: Terminated)
Note: This field may return null, indicating that no valid values can be obtained.
IsolateTime Integer Service suspension time in milliseconds
Note: This field may return null, indicating that no valid values can be obtained.
HttpPublicEndpoint String HTTP-based public network access address
Note: This field may return null, indicating that no valid values can be obtained.
HttpVpcEndpoint String HTTP-based VPC access address
Note: This field may return null, indicating that no valid values can be obtained.
InternalEndpoint String Internal TCP access address
Note: This field may return null, indicating that no valid values can be obtained.
HttpInternalEndpoint String Internal HTTP access address
Note: This field may return null, indicating that no valid values can be obtained.
AclEnabled Boolean Whether to enable ACL authentication. For Exclusive Edition instances, ACL authentication can be disabled.
Note: This field may return null, indicating that no valid values can be obtained.
PublicClbId String Public network CLB instance ID
Note: This field may return null, indicating that no valid values can be obtained.
Vip String vip
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String Specifies the VPC it belongs to.
Note: This field may return null, indicating that no valid values can be obtained.
SupportMigration Boolean Whether migration is supported.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceStatus Integer Instance status:
0: Creating
1: Normal
2: Isolating
3: Destroyed
4: Abnormal
5: Deliver failed
6: Changing the configuration
7: Configuration change failed
Note: This field may return null, indicating that no valid values can be obtained.
ZoneId Integer Indicates the AZ to which the cluster belongs.
Note: This field may return null, indicating that no valid values can be obtained.
ZoneIds Array of Integer The AZ where the cluster nodes are located. If the cluster is a cross-AZ cluster, it includes multiple AZs where the cluster nodes are located.
Note: This field may return null, indicating that no valid values can be obtained.
IsFrozen Boolean Whether it is frozen.
AutoCreateTopicEnabled Boolean Whether to enable automatic topic creation.
AdminFeatureEnabled Boolean Whether to enable the admin feature of the cluster.
AdminAccessKey String Admin AK
Note: This field may return null, indicating that no valid values can be obtained.
AdminSecretKey String Admin SK
Note: This field may return null, indicating that no valid values can be obtained.
EnableDeletionProtection Boolean Whether to enable deletion protection

RocketMQClusterRecentStats

Recent RocketMQ usage

Used by actions: DescribeRocketMQCluster.

Name Type Description
TopicNum Integer Number of topics
ProducedMsgNum Integer Number of produced messages
ConsumedMsgNum Integer Number of consumed messages
AccumulativeMsgNum Integer Number of retained messages

RocketMQDataPoint

Monitoring data points

Used by actions: DescribeRocketMQPublicAccessMonitorData.

Name Type Description
Timestamps Array of Integer Monitoring value array, which corresponds one-to-one with Timestamps
Note: This field may return null, indicating that no valid values can be obtained.
Values Array of Float Monitoring data point position. For example, a day is divided into 1,440 points per minute, with each point having a serial number between 0 and 1439. If a certain serial number is not in the array, it indicates a missing data point.
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQGroup

RocketMQ consumer group information

Used by actions: DescribeRocketMQGroups.

Name Type Description
Name String Consumer group name.
ConsumerNum Integer The number of online consumers.
ConsumptionMode Integer 0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
ReadEnabled Boolean Whether to allow consumption.
RetryPartitionNum Integer The number of partitions in a retry topic.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime Integer Creation time in milliseconds.
UpdateTime Integer Modification time in milliseconds.
ClientProtocol String Client protocol.
Remark String Description.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerType String Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
Note: This field may return null, indicating that no valid values can be obtained.
BroadcastEnabled Boolean Whether to enable broadcast consumption.
GroupType String Group type
Note: This field may return null, indicating that no valid values can be obtained.
RetryMaxTimes Integer The number of retries
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.
Namespace String Namespace
Note: This field may return null, indicating that no valid values can be obtained.
SubscribeTopicNum Integer Number of subscribed topics.
TagList Array of Tag List of bound tags

RocketMQInstanceConfig

Instance configurations of a TDMQ for RocketMQ exclusive cluster

Used by actions: DescribeRocketMQVipInstanceDetail.

Name Type Description
MaxTpsPerNamespace Integer Maximum TPS per namespace
MaxNamespaceNum Integer Maximum number of namespaces
UsedNamespaceNum Integer Number of used namespaces
MaxTopicNum Integer Maximum number of topics
UsedTopicNum Integer Number of used topics
MaxGroupNum Integer Maximum number of groups
UsedGroupNum Integer Number of used groups
ConfigDisplay String Cluster type
NodeCount Integer Number of nodes in the cluster
NodeDistribution Array of InstanceNodeDistribution Node distribution
TopicDistribution Array of RocketMQTopicDistribution Topic distribution
MaxQueuesPerTopic Integer
MaxRetention Integer Maximum configurable message retention time, in hours
Note: This field may return null, indicating that no valid values can be obtained.
MinRetention Integer Minimum configurable message retention time, in hours
Note: This field may return null, indicating that no valid values can be obtained.
Retention Integer Instance message retention time, in hours
Note: This field may return null, indicating that no valid values can be obtained.
TopicNumLowerLimit Integer Minimum quota for the number of topics, which is the free quota. The default number is the minimum quota per node in the cluster specification multiplied by the number of nodes.
Note: This field may return null, indicating that no valid values can be obtained.
TopicNumUpperLimit Integer Maximum quota for the number of topics. The default number is the maximum quota per node in the cluster specification multiplied by the number of nodes.
Note: This field may return null, indicating that no valid values can be obtained.
SendReceiveRatio Float Controls the TPS ratio for producing and consuming messages. Value range: 0–1. Default value: 0.5.

RocketMQMessageTrack

TDMQ for RocketMQ message trace information

Used by actions: DescribeRocketMQMsg.

Name Type Description
Group String Consumer group
ConsumeStatus String Consumption status.
CONSUMED.
CONSUMED BUT FILTERED.
NOT_CONSUME: specifies unconsumed.
ENTER_RETRY: specifies whether to enter the retry queue.
ENTER_DLQ: specifies whether the message enters the dead letter queue.
Consumption status UNKNOWN.
TrackType String Message trace type
ExceptionDesc String Exception information
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQMsgLog

RocketMQ Message Log

Used by actions: DescribeRocketMQTopicMsgs.

Name Type Description
MsgId String Message ID
MsgTag String Message tag
Note: This field may return null, indicating that no valid values can be obtained.
MsgKey String Message key.
Note: This field may return null, indicating that no valid values can be obtained.
ProducerAddr String Specifies the client ip address.
ProduceTime String Message Sending Time
PulsarMsgId String Pulsar Message ID
DeadLetterResendTimes Integer Dead-letter resend count
Note: This field may return null, indicating that no valid values can be obtained.
ResendSuccessCount Integer Dead Letter Resend Success Count
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQNamespace

RocketMQ namespace information

Used by actions: DescribeRocketMQNamespaces.

Name Type Description
NamespaceId String Namespace name, which can contain 3 - 64 letters, digits, hyphens, and underscores.
Ttl Integer Retention period for unconsumed messages in milliseconds. Valid range: 60 seconds - 15 days. This parameter is disused.
RetentionTime Integer Retention period for persistently stored messages in milliseconds.
Remark String Description.
Note: This field may return null, indicating that no valid values can be obtained.
PublicEndpoint String Public network access point address.
Note: This field may return null, indicating that no valid values can be obtained.
VpcEndpoint String VPC access point address.
Note: This field may return null, indicating that no valid values can be obtained.
InternalEndpoint String Internal access point address
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQSubscription

RocketMQ Consumer Group Subscription Information

Used by actions: DescribeRocketMQTopic, DescribeRocketMQTopics.

Name Type Description
Topic String Topic name
Type String Topic type.
Normal.
GlobalOrder specifies the global sequential order.
Partitionally sequential.
Transactional message.
DelayScheduled specifies the delayed message.
Retry.
DeadLetter. specifies the dead letter.
Note: This field may return null, indicating that no valid values can be obtained.
PartitionNum Integer Number of partitions
Note: This field may return null, indicating that no valid values can be obtained.
ExpressionType String Filter mode, which can be TAG or SQL.
Note: This field may return null, indicating that no valid values can be obtained.
SubString String Filter expression.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Subscription status:.
Consistent subscription relationship.
Inconsistent subscription relationship.
2. unknown.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLag Integer Number of heaped consumer groups.
Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String Instance ID.
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 Integer Consumption type.
Broadcast consumption.
Specifies the cluster consumption.
Note: This field may return null, indicating that no valid values can be obtained.
Consistency Integer Subscription consistency.
Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime Integer Last consumption progress update time, in seconds
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.
ClientProtocol String Protocol type.
Note: This field may return null, indicating that no valid values can be obtained.
ClientSubscriptionInfos Array of ClientSubscriptionInfo Client subscription details.
Note: This field may return null, indicating that no valid values can be obtained.

RocketMQTopic

RocketMQ topic information

Used by actions: DescribeRocketMQTopic, DescribeRocketMQTopics.

Name Type Description
Name String Topic name.
Type String Topic type. Enumerated values: Normal, GlobalOrder, PartitionedOrder, Transaction, Retry, and DeadLetter.
GroupNum Integer The number of subscription groups
Remark String Description.
Note: This field may return null, indicating that no valid values can be obtained.
PartitionNum Integer The number of read/write partitions.
CreateTime Integer Creation time in milliseconds.
UpdateTime Integer Creation time in milliseconds.
InstanceId String Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.
Namespace String Namespace
Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime Integer Last write time, in seconds.
Note: This field may return null, indicating that no valid values can be obtained.
SubscriptionCount Integer Number of Subscriptions
Note: This field may return null, indicating that no valid values can be obtained.
SubscriptionData Array of RocketMQSubscription Subscribe to the relationship list.
Note: This field may return null, indicating that no valid values can be obtained.
TagList Array of Tag List of bound tags

RocketMQTopicDistribution

TDMQ for RocketMQ topic distribution

Used by actions: DescribeRocketMQCluster, DescribeRocketMQVipInstanceDetail.

Name Type Description
TopicType String Topic type
Count Integer Number of topics

RocketMQVipInstance

Information of TDMQ for RocketMQ exclusive instances

Used by actions: DescribeRocketMQVipInstances.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceVersion String Instance version.
Status Integer Instance status. Valid values: 0 (Creating), 1 (Normal), 2 (Isolated), 3 (Terminated), 4 (Abnormal), 5 (Delivery failed).
NodeCount Integer Number of nodes
ConfigDisplay String Instance specification name
MaxTps Integer Peak TPS
MaxBandWidth Integer Peak bandwidth in Mbps
MaxStorage Integer Storage capacity in GB
ExpireTime Integer Instance expiration time in milliseconds
AutoRenewFlag Integer Renewal mode. Valid values: 0 (Manual renewal, which is the default mode), 1 (Auto-renewal), 2 (Manual renewal, which is specified by users).
PayMode Integer Payment mode. 0: Postpaid; 1: Prepaid.
Remark String Remarks
SpecName String Instance specification ID
MaxRetention Integer Maximum configurable message retention time, in hours
MinRetention Integer Minimum configurable message retention time, in hours
Retention Integer Instance message retention time, in hours
AclEnabled Boolean Whether to enable ACL authentication.
DestroyTime Integer Destruction time.

Role

Role instance

Used by actions: DescribeRocketMQRoles, DescribeRoles.

Name Type Description
RoleName String Role name.
Token String Value of the role token.
Remark String Remarks.
CreateTime Timestamp Creation time.
UpdateTime Timestamp Update time.
PermType String Authorization type (Cluster: cluster; TopicAndGroup: topic or consumer group).

SecurityPolicy

Security policy.

Used by actions: DescribePulsarProInstanceDetail, ModifyPublicNetworkSecurityPolicy.

Name Type Required Description
Route String No ip or subnet.
Note: This field may return null, indicating that no valid values can be obtained.
Policy Boolean No Specifies whether the policy allows (true) or denies (false) access, corresponding to the allowlist or blocklist.

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.

ServerLog

Service Provider Information

Used by actions: DescribeMsgTrace.

Name Type Description
SaveTime String Storage time.
Status String Status.

Sort

Sort by field

Used by actions: DescribePublishers.

Name Type Required Description
Name String Yes Sorting field.
Order String Yes Ascending order: ASC; descending order: DESC.

Subscription

Subscriber

Used by actions: DescribeSubscriptions.

Name Type Description
TopicName String Topic name.
EnvironmentId String Environment (namespace) name.
ConnectedSince String The time when the consumer started connecting.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerAddr String Consumer address.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerCount String The number of consumers.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerName String Consumer name.
Note: This field may return null, indicating that no valid values can be obtained.
MsgBacklog String The number of heaped messages.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateExpired String Percentage of messages under this subscription that were discarded but not sent after TTL.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateOut String The total number of messages delivered by the consumer per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgThroughputOut String The size (in bytes) of messages consumed by the consumer per second.
Note: This field may return null, indicating that no valid values can be obtained.
SubscriptionName String Subscription name.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerSets Array of Consumer Set of consumers.
Note: This field may return null, indicating that no valid values can be obtained.
IsOnline Boolean Whether the consumer is online.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumersScheduleSets Array of ConsumersSchedule Set of consumption progress information.
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.
CreateTime Timestamp Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime Timestamp Last modified.
Note: This field may return null, indicating that no valid values can be obtained.
SubType String Subscription type. Valid values: Exclusive, Shared, Failover, and Key_Shared. An empty string or NULL: Unknown.
Note: This field may return null, indicating that no valid values can be obtained.
BlockedSubscriptionOnUnackedMsgs Boolean Whether messages are blocked as the limit of unacknowledged messages has been reached.
Note: This field may return null, indicating that no valid values can be obtained.
MaxUnackedMsgNum Integer The maximum number of unacknowledged messages.
Note: This field may return null, indicating that no valid values can be obtained.

SubscriptionTopic

Subscription

Used by actions: DeleteSubscriptions.

Name Type Required Description
EnvironmentId String Yes Environment (namespace) name.
TopicName String Yes Topic name.
SubscriptionName String Yes Subscription name.

Tag

Type of the tag key/value

Used by actions: CreateCluster, CreateCmqQueue, CreateCmqTopic, CreateProCluster, CreateRabbitMQVipInstance, CreateRocketMQCluster, CreateRocketMQVipInstance, DescribeClusterDetail, DescribeClusters, DescribeCmqQueueDetail, DescribeCmqQueues, DescribeCmqTopicDetail, DescribeCmqTopics, DescribePulsarProInstances, DescribeRabbitMQVipInstance, DescribeRabbitMQVipInstances, DescribeRocketMQGroups, DescribeRocketMQTopic, DescribeRocketMQTopics.

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

TagFilter

Tag filter

Used by actions: DescribeRocketMQGroups, DescribeRocketMQTopics.

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

Topic

Topic instance

Used by actions: DescribeTopics.

Name Type Description
AverageMsgSize String Average size of the messages published in the last interval in bytes.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerCount String The number of consumers.
Note: This field may return null, indicating that no valid values can be obtained.
LastConfirmedEntry String The total number of recorded messages.
Note: This field may return null, indicating that no valid values can be obtained.
LastLedgerCreatedTimestamp String Time when the last ledger was created.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateIn String The number of messages published by local and replicated publishers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgRateOut String The total number of messages delivered by local and replicated consumers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgThroughputIn String The size (in bytes) of messages published by local and replicated publishers per second.
Note: This field may return null, indicating that no valid values can be obtained.
MsgThroughputOut String The size (in bytes) of messages delivered by local and replicated consumers per second.
Note: This field may return null, indicating that no valid values can be obtained.
NumberOfEntries String The total number of recorded messages.
Note: This field may return null, indicating that no valid values can be obtained.
Partitions Integer Partition count ≤ 0: there are no subpartitions in the topic.
Note: This field may return null, indicating that no valid values can be obtained.
ProducerCount String The number of producers.
Note: This field may return null, indicating that no valid values can be obtained.
TotalSize String The size of all stored messages in bytes.
Note: This field may return null, indicating that no valid values can be obtained.
SubTopicSets Array of PartitionsTopic Subpartitions in a partitioned topic.
Note: This field may return null, indicating that no valid values can be obtained.
TopicType Integer Topic type description:
0: General message;
1: Globally sequential message;
2: Partitionally sequential message;
3: Retry letter topic;
4: Dead letter topic;
5: Transaction message.
Note: This field may return null, indicating that no valid values can be obtained.
EnvironmentId String Environment (namespace) name.
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.
Remark String Remarks (up to 128 characters).
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime Timestamp Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime Timestamp Last modified.
Note: This field may return null, indicating that no valid values can be obtained.
ProducerLimit String The maximum number of producers.
Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLimit String The maximum number of consumers.
Note: This field may return null, indicating that no valid values can be obtained.
PulsarTopicType Integer 0: Non-persistent and non-partitioned
1: Non-persistent and partitioned
2: Persistent and non-partitioned
3: Persistent and partitioned
Note: This field may return null, indicating that no valid values can be obtained.
MsgTTL Integer Retention period for unconsumed messages in seconds.

Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String Cluster ID
Tenant String Tenant alias customized by users. if there is no, reuse the professional cluster ID.
IsolateConsumerEnable Boolean Whether exception consumer isolation is enabled.
AckTimeOut Integer Specifies the consumer Ack timeout period in seconds.

TopicRecord

Topic's key information

Used by actions: DeleteTopics.

Name Type Required Description
EnvironmentId String Yes Environment (namespace) name.
TopicName String Yes Topic name.

TopicStats

Topic status.

Used by actions: DescribeRocketMQTopicStats.

Name Type Description
BrokerName String Broker node.
Note: This field may return null, indicating that no valid values can be obtained.
QueueId Integer Queue number.
Note: This field may return null, indicating that no valid values can be obtained.
MinOffset Integer Minimum offset.
Note: This field may return null, indicating that no valid values can be obtained.
MaxOffset Integer Specifies the maximum offset.
Note: This field may return null, indicating that no valid values can be obtained.
MessageCount Integer Message count.
Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTimestamp Integer Last message write time.
Note: This field may return null, indicating that no valid values can be obtained.

TraceResult

Message Trace Result

Used by actions: DescribeMqMsgTrace, DescribeRocketMQMsgTrace.

Name Type Description
Stage String Stage.
Data String Content details

VirtualHostQuota

Used by actions: DescribeRabbitMQVipInstance.

Name Type Description
MaxVirtualHost Integer
UsedVirtualHost Integer Number of created vhosts.
MaxConnectionPerVhost Integer Specifies the maximum number of connections allowed per vhost.
MaxExchangePerVhost Integer Specifies the maximum number of switches allowed in one vhost.
MaxQueuePerVhost Integer Specifies the maximum number of queue machines allowed in one vhost.

VpcBindRecord

VPC binding record

Used by actions: DescribeBindVpcs.

Name Type Description
UniqueVpcId String Tenant VPC ID
UniqueSubnetId String Tenant VPC subnet ID
RouterId String Route ID
Ip String VPC ID
Port Integer VPC port
Remark String Remarks (up to 128 characters)
Note: this field may return null, indicating that no valid values can be obtained.

VpcConfig

VPC configuration information

Used by actions: DescribeRocketMQCluster, DescribeRocketMQVipInstanceDetail.

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

VpcEndpointInfo

Used by actions: DescribeRabbitMQVipInstance, DescribeRabbitMQVipInstances.

Name Type Required Description
VpcId String Yes
SubnetId String Yes
VpcEndpoint String Yes
VpcDataStreamEndpointStatus String No Access point status. valid values: OFF, ON, CREATING, DELETING.
VpcTlsEndpoint String No Encrypted TLS data stream access point.

VpcInfo

VPC information (consists of UniqVpcId and UniqSubnetId).

Used by actions: CreateProCluster, CreateRocketMQVipInstance.

Name Type Required Description
VpcId String Yes VPC information
SubnetId String Yes Subnet information.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback