tencent cloud

APIs

DocumentaçãoAPIsTDMQ for RabbitMQData Types

Data Types

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-07-13 17:45:48

ExchangeQuota

Specifies the exchange usage quota information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
MaxExchange Integer Specifies the maximum number of exchanges that can be created.
UsedExchange Integer Specifies the number of exchanges that have been created.

Filter

Filter parameter

Used by actions: DescribeRabbitMQServerlessVirtualHost, ListRabbitMQServerlessInstances.

Name Type Required Description
Name String No name.
Values Array of String No Value.

QueueQuota

Specifies the queue usage quota information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
MaxQueue Integer Specifies the maximum number of queues that can be created.
UsedQueue Integer Number of queues created.

RabbitMQBindingListInfo

Rabbitmq binding relationship list member.

Used by actions: DescribeRabbitMQServerlessBindings.

Name Type Description
BindingId Integer

Routing relationship id
VirtualHost String

Vhost parameter
Source String

Source exchange name
DestinationType String

Target type, queue or exchange
Destination String

Target resource name
RoutingKey String

Bind key
SourceExchangeType String

Source exchange type
CreateTime String

Creation time.
ModifyTime String

Modification time.
Arguments Array of RabbitMQServerlessKeyValuePair

Bind parameter. Parameters can be passed in during binding for header type Exchange. No need to input for other types of Exchange.

RabbitMQClusterInfo

RabbitMQ cluster basic information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
ClusterId String

Cluster ID.
ClusterName String

Cluster name.
Region String

Regional information
CreateTime Integer

Creation time in milliseconds
Remark String

Cluster description information
Vpcs Array of VpcEndpointInfo

VPC and network info
ZoneIds Array of Integer

AZ information
VirtualHostNumber Integer

Number of virtual hosts
QueueNumber Integer

Number of queues
MessagePublishRate Float

Number of messages produced per second Unit: messages/second
MessageStackNumber Integer

Number of accumulated messages Unit: unit
ExpireTime Integer

Expiration time
ChannelNumber Integer

Number of channels
ConnectionNumber Integer

Number of connections
ConsumerNumber Integer

Number of consumers
ExchangeNumber Integer

Number of Exchanges
ExceptionInformation String

Cluster exception information
ClusterStatus Integer

Instance status. 0 indicates creating in progress, 1 indicates normal, 2 indicates isolated, 3 indicates terminated, 4 - abnormal, 5 - delivery failed
AutoRenewFlag Integer

Automatic renewal flag. 0: default status (initial status (that is manual renewal) if no status is set by the user); 1: automatic renewal; 2: no automatic renewal (set by the user).
MirrorQueuePolicyFlag Integer

Whether to enable the mirror queue policy. 1 means enabled, 0 means 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

Cluster type.
MessageRetainTime Integer

Message retention period Unit: hour
SendReceiveRatio Float

Traffic ratio of sending messages
TraceTime Integer

Message trace retention time in hours
Tags Array of RabbitMQServerlessTag

Instance tag list
ElasticTpsFlag Boolean

Elastic scaling enabled tps
ElasticTpsRatio Float

Elastic tps multiple, default is 1x
MaxRedeliverCount Integer

Maximum retry count
ConsumerTimeout Integer

Consumption timeout period Unit: min

RabbitMQClusterSpecInfo

RabbitMQ cluster specification information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
SpecName String Specifies the cluster specification name.
MaxTps Integer Max tps.
MaxQueueNum Integer Maximum number of queues.
MaxExchangeNum Integer Maximum number of exchanges.
MaxVhostNum Integer Maximum number of vhosts.
MaxConnNum Integer Maximum number of connections.
MaxUserNum Integer Maximum number of users.
MaxBandWidth Integer Peak bandwidth. abandoned.
PublicNetworkTps Integer Public network bandwidth. abandoned.
Features String Feature list corresponding to the instance, yes means supported, no means unsupported

RabbitMQConnection

RabbitMQ connection detail.

Used by actions: DescribeRabbitMQServerlessConnection.

Name Type Description
ConnectionName String Connection name.
PeerHost String Client IP
State String Specifies the connection status, including starting, tuning, opening, running, flow, blocking, blocked, closing, and closed.
User String User that who has created this connection.
SSL Boolean Whether ssl is enabled.
Protocol String Connection protocol.
Channels Integer Specifies the number of channels under the connection.
IncomingBytes Float Inbound traffic volume in bytes
OutgoingBytes Float Outbound traffic volume in bytes
Heartbeat Integer Heartbeat interval. Default 60s.
MaxChannel Integer Maximum number of channels per link. Default 1024.
IdleSince String Idle time point

RabbitMQConsumersListInfo

Queue consumer list information.

Used by actions: DescribeRabbitMQServerlessConsumers.

Name Type Description
ClientIp String Client Ip.
ConsumerTag String Consumer Tag.
QueueName String Consume target queue
AckRequired Boolean Whether required for the consumer to manually ack
PrefetchCount Integer Consumer qos value
Active String Consumer status
LastDeliveredTime String Time of the last message submission
UnAckMsgCount Integer Number of unconfirmed messages of the consumer
ChannelName String channel belonging to the consumer

RabbitMQExchangeListInfo

RabbitMQ exchange list member information.

Used by actions: DescribeRabbitMQServerlessExchanges.

Name Type Description
ExchangeName String exchange name.
Remark String Remarks.
ExchangeType String Specifies the exchange type. valid values: "fanout", "direct", "topic", "headers".
VirtualHost String VHost parameter.
ExchangeCreator String exchange creator. valid values: system (generated by the system), user (user-created).
CreateTimeStamp String exchange creation time.
ModTimeStamp String exchange modification time.
MessageRateIn Float Input message rate.
MessageRateOut Float Output message rate.
Durable Boolean Specifies whether it is a persistent exchange. true indicates persistent, and false indicates non-persistent.
AutoDelete Boolean Specifies whether to automatically delete the switch. true indicates automatic deletion, and false indicates non-automatic deletion.
Internal Boolean Whether it is an internal switch. valid values: true (indicating an internal switch).
InstanceId String Specifies the ID of the associated instance to which the switch belongs.
Policy String The name of the effective policy.
Arguments String Additional parameters key-value objects.
MessagesDelayed Integer Number of unscheduled delayed messages.

RabbitMQPermission

RabbitMQ permission details.

Used by actions: DescribeRabbitMQServerlessPermission.

Name Type Description
InstanceId String instance ID
User String Specifies the username, which is the user associated with the permission.
VirtualHost String vhost name.
ConfigRegexp String Types of permissions. declare related operations. for the user, it is operable to perform operations on the resource name under the vhost that matches the regular expression.
WriteRegexp String Types of permissions. message write related operations. the user can operate on the resource names under the vhost that match the regular expression.
ReadRegexp String Types of permissions. message read related operations. the user can operate on the resource name under the vhost that matches the regular expression.
CreateTime String Creation time
ModifyTime String Modification time

RabbitMQQueueListConsumerDetailInfo

RabbitMQ queue list consumer information response parameters structure.

Used by actions: DescribeRabbitMQServerlessQueues.

Name Type Description
ConsumersNumber Integer Number of consumers.

RabbitMQQueueListInfo

RabbitMQ queue list member information.

Used by actions: DescribeRabbitMQServerlessQueues.

Name Type Description
QueueName String Queue name.
Remark String Remarks.
ConsumerDetail RabbitMQQueueListConsumerDetailInfo Consumer information.
QueueType String Specifies the queue type. the valid values are "classic" and "quorum".
MessageHeapCount Integer Number of message backlogs.
MessageRateIn Float Message production rate per second.
MessageRateOut Float Message consumption rate per second.
CreateTime String Creation time
ModifyTime String Modification time
Durable Boolean Specifies whether the queue is persistent. true indicates persistent, and false indicates non-persistent.
AutoDelete Boolean Specifies whether the queue is an auto-delete queue. true indicates auto-delete, and false indicates non-auto-delete.
InstanceId String instanceId to which the queue belongs.
VirtualHost String Name of the virtual host to which the queue belongs.
Node String Specifies the name of the primary node where the queue is located.
Policy String The name of the effective policy.
Arguments String Additional parameters key-value objects.
Exclusive Boolean Whether it is an exclusive queue.

RabbitMQServerlessAccessInfo

Public network access information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
PublicAccessEndpoint String Public network domain.
PublicDataStreamStatus String Public network status.
PublicClbId String Public network CLB instance ID

RabbitMQServerlessEndpoint

Access point.

Used by actions: ListRabbitMQServerlessInstances.

Name Type Description
VpcId String vpc id
SubnetId String subnet id
VpcEndpoint String Access address
VpcDataStreamEndpointStatus String Access address status.
PublicNetwork Boolean Whether it is a public network.
AccessStrategy String Specifies the access policy.
Bandwidth Integer Bandwidth

RabbitMQServerlessInstance

TDMQ for rabbitmq serverless instance.

Used by actions: ListRabbitMQServerlessInstances.

Name Type Description
InstanceId String Instance ID
InstanceName String Instance name
InstanceVersion String Instance version.
Status Integer Instance status. 0 indicates creating in progress. 1 indicates normal. 2 indicates isolated. 3 indicates terminated. 4 indicates exception. 5 indicates delivery failed.
MaxTps Integer MaxTPS
MaxBandWidth Integer MaxBandwidth
ExpireTime Integer Expiration time of the cluster.
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).
PayMode Integer 0: Postpaid, 1: Prepaid
Remark String Remarks
SpecName String Cluster specifications
ExceptionInformation String Exception information.
PublicAccessEndpoint String Public network access point.
Vpcs Array of RabbitMQServerlessEndpoint The virtual private cloud (vpc) network access point.
ClusterStatus Integer Instance status. 0 indicates creating in progress. 1 indicates normal. 2 indicates isolated. 3 indicates terminated. 4 indicates exception. 5 indicates delivery failed.
InstanceType Integer Specifies the cluster type: 1.
CreateTime Integer Expiration time
NodeCount Integer For compatibility with the managed version, the fixed value is 0.
MaxStorage Integer For compatibility with the managed version, the fixed value is 0.
IsolatedTime Integer Isolation time
ServerlessExt String Serverless Extension Fields
Tags Array of RabbitMQServerlessTag Instance tag list.

RabbitMQServerlessKeyValuePair

Key-value pair

Used by actions: CreateRabbitMQServerlessBinding, DescribeRabbitMQServerlessBindings.

Name Type Required Description
Key String No Key.
Value String No Value.

RabbitMQServerlessTag

Tag.

Used by actions: DescribeRabbitMQServerlessInstance, ListRabbitMQServerlessInstances, ModifyRabbitMQServerlessInstance.

Name Type Required Description
TagKey String No Tag key.
TagValue String No Tag value.

RabbitMQServerlessWhiteListInfo

Public network allowlist information.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
PublicDataStreamWhiteList String Public network data stream allowlist.
PublicDataStreamWhiteListStatus String Public network data stream allowlist status.

RabbitMQUser

RabbitMQ user info detail.

Used by actions: DescribeRabbitMQServerlessUser.

Name Type Description
InstanceId String instance ID
User String Specifies the username used when logging in.
Password String Password. specifies the password used when logging in.
Description String User description
Tags Array of String User tag. specifies to determine the access permission scope of this user to RabbitMQ Management.
CreateTime String User creation time
ModifyTime String Last modification time of the user.
Type String Type of User. specifies that "System" indicates System creation and "User" indicates User-created.
MaxConnections Integer Specifies the maximum number of connections allowed for this user.
MaxChannels Integer The maximum number of channels allowed for this user.

RabbitMQVirtualHostInfo

RabbitMQ vhost detail.

Used by actions: DescribeRabbitMQServerlessVirtualHost.

Name Type Description
InstanceId String instance ID
VirtualHost String Vhost name.
Description String Specifies the description information of the vhost.
Tags Array of String Specifies the Tag of the vhost.
CreateTime String Creation time
ModifyTime String Modification time
VirtualHostStatistics RabbitMQVirtualHostStatistics Specifies the overview statistics information of the vhost.
Status String vhost status. specifies the status that corresponds to the native console and can be running, partial, stopped, or unknown.
MessageHeapCount Integer Specifies the number of message backlogs.
MessageRateIn Float Input message rate.
MessageRateOut Float Output message rate.
MirrorQueuePolicyFlag Boolean Specifies whether a mirrored queue policy exists. true indicates existence, and false indicates non-existence.

RabbitMQVirtualHostStatistics

vhost overview statistical information.

Used by actions: DescribeRabbitMQServerlessVirtualHost.

Name Type Description
CurrentQueues Integer Number of queues of the current vhost.
CurrentExchanges Integer Number of exchanges in the current vhost.
CurrentConnections Integer Number of current connections of the vhost.
CurrentChannels Integer Number of channels for the current vhost.
CurrentUsers Integer Number of users of the current vhost.

UserQuota

Number of users quota.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
MaxUser Integer Maximum number of users.
UsedUser Integer Used number of users.

VirtualHostQuota

Virtual host quota.

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Description
MaxVirtualHost Integer Maximum number of virtual hosts.
UsedVirtualHost Integer Number of already used virtual hosts.

VpcEndpointInfo

VPC access point information

Used by actions: DescribeRabbitMQServerlessInstance.

Name Type Required Description
VpcId String Yes VPC ID
SubnetId String Yes Subnet ID
VpcEndpoint String Yes vpc access point information.
VpcDataStreamEndpointStatus String No vpc access point status.
OFF/ON/CREATING/DELETING
Anterior: CreateRabbitMQServerlessBindingPróximo: Error Codes

Ajuda e Suporte

Esta página foi útil?

comentários