Information of dedicated clusters
Used by actions: DescribeBindClusters.
Name | Type | Description |
---|---|---|
ClusterName | String | Name of a physical 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-go1 : Monthly subscriptionNote: This field may return null , indicating that no valid values can be obtained. |
cmq DeadLetterPolicy
Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.
Name | Type | Description |
---|---|---|
DeadLetterQueue | String | Dead letter queue. Note: this field may return null, indicating that no valid values can be obtained. |
Policy | Integer | Dead letter queue policy. Note: this field may return null, indicating that no valid values can be obtained. |
MaxTimeToLive | Integer | Maximum period in seconds before an unconsumed message expires, which is required if Policy is 1. Value range: 300–43200. This value should be smaller than MsgRetentionSeconds (maximum message retention period)Note: this field may return null, indicating that no valid values can be obtained. |
MaxReceiveCount | Integer | Maximum number of receipts. Note: this field may return null, indicating that no valid values can be obtained. |
Cmq DeadLetterSource
Used by actions: DescribeCmqDeadLetterSourceQueues, 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. Note: this field may return null, indicating that no valid values can be obtained. |
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 of the number of messages produced per second. The value for consumed messages is 1.1 times this value. Note: this field may return null, indicating that no valid values can be obtained. |
Bps | Integer | Bandwidth limit. Note: this field may return null, indicating that no valid values can be obtained. |
MaxDelaySeconds | Integer | Maximum retention period for inflight messages. Note: this field may return null, indicating that no valid values can be obtained. |
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 wait time for message reception. Value range: 0–30 seconds. Default value: 0. Note: this field may return null, indicating that no valid values can be obtained. |
MsgRetentionSeconds | Integer | Message retention period. Value range: 60–1296000 seconds (i.e., 1 minute–15 days). Default value: 345600 (i.e., 4 days). Note: this field may return null, indicating that no valid values can be obtained. |
VisibilityTimeout | Integer | Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30. Note: this field may return null, indicating that no valid values can be obtained. |
MaxMsgSize | Integer | Maximum message length. Value range: 1024–1048576 bytes (i.e., 1–1024 KB). Default value: 65536. Note: this field may return null, indicating that no valid values can be obtained. |
RewindSeconds | Integer | Maximum time range during which a message can be rewound in the queue, which ranges from 0 to 43,200 seconds. 0 indicates that message rewind is disabled. Note: this field may return null, indicating that no valid values can be obtained. |
CreateTime | Integer | Queue creation time. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
LastModifyTime | Integer | Time when the queue attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
ActiveMsgNum | Integer | Total number of messages in Active status (i.e., unconsumed) in the queue, which is an approximate value.Note: this field may return null, indicating that no valid values can be obtained. |
InactiveMsgNum | Integer | Total number of messages in Inactive status (i.e., being consumed) in the queue, which is an approximate value.Note: this field may return null, indicating that no valid values can be obtained. |
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 Note: this field may return null, indicating that no valid values can be obtained. |
NamespaceName | String | Namespace name 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 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. |
MaxMsgBacklogSize | Integer | Maximum size of heaped messages in bytes. Note: this field may return null , indicating that no valid values can be obtained. |
RetentionSizeInMB | Integer | Queue storage space configured for message rewind. Value range: 1,024-10,240 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled. Note: This field may return null , indicating that no valid values can be obtained. |
Subscription response parameter in CMQ
Used by actions: DescribeCmqSubscriptionDetail.
Name | Type | Description |
---|---|---|
SubscriptionName | String | Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. Note: this field may return null, indicating that no valid values can be obtained. |
SubscriptionId | String | Subscription ID, which will be used during monitoring data pull. Note: this field may return null, indicating that no valid values can be obtained. |
TopicOwner | Integer | Subscription owner APPID .Note: this field may return null, indicating that no valid values can be obtained. |
MsgCount | Integer | Number of messages to be delivered in the subscription. Note: this field may return null, indicating that no valid values can be obtained. |
LastModifyTime | Integer | Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
CreateTime | Integer | Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
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 | Endpoint that receives notifications, which varies by protocol : for HTTP, the endpoint must start with http:// , and the host can be a domain or IP; for queue , queueName should be entered.Note: this field may return null, indicating that no valid values can be obtained. |
FilterTags | Array of String | Filtering policy selected when a subscription is created: If filterType is 1, filterTag will be used for filtering.If filterType is 2, bindingKey will be used for filtering.Note: this field may return null, indicating that no valid values can be obtained. |
Protocol | String | Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Note: this field may return null, indicating that no valid values can be obtained. |
NotifyStrategy | String | CMQ push server retry policy in case an error occurs while pushing a message to the endpoint. Valid values: (1) BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. (2) EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. Note: this field may return null, indicating that no valid values can be obtained. |
NotifyContentFormat | String | Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If protocol is queue , this value must be SIMPLIFIED . If protocol is HTTP , both values are acceptable, and the default value is JSON .Note: this field may return null, indicating that no valid values can be obtained. |
Display field of the returned CMQ topic information
Used by actions: DescribeCmqTopicDetail, DescribeCmqTopics.
Name | Type | Required | Description |
---|---|---|---|
TopicId | String | Yes | Topic ID. Note: this field may return null, indicating that no valid values can be obtained. |
TopicName | String | Yes | Topic name. Note: this field may return null, indicating that no valid values can be obtained. |
MsgRetentionSeconds | Integer | Yes | Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. Note: this field may return null, indicating that no valid values can be obtained. |
MaxMsgSize | Integer | Yes | Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB). The default value is 65,536. Note: this field may return null, indicating that no valid values can be obtained. |
Qps | Integer | Yes | Number of messages published per second. Note: this field may return null, indicating that no valid values can be obtained. |
FilterType | Integer | Yes | Filtering policy selected when a subscription is created: If filterType is 1, FilterTag will be used for filtering.If filterType is 2, BindingKey will be used for filtering.Note: this field may return null, indicating that no valid values can be obtained. |
CreateTime | Integer | Yes | Topic creation time. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
LastModifyTime | Integer | Yes | Time when the topic attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. Note: this field may return null, indicating that no valid values can be obtained. |
MsgCount | Integer | Yes | Number of current messages in the topic (number of retained messages). Note: this field may return null, indicating that no valid values can be obtained. |
CreateUin | Integer | Yes | 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 | Yes | Associated tag. Note: this field may return null, indicating that no valid values can be obtained. |
Trace | Boolean | Yes | Message trace. true: enabled; false: not enabled Note: this field may return null, indicating that no valid values can be obtained. |
TenantId | String | Yes | Tenant ID Note: this field may return null, indicating that no valid values can be obtained. |
NamespaceName | String | Yes | Namespace name Note: this field may return null, indicating that no valid values can be obtained. |
Status | Integer | Yes | 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. |
BrokerType | Integer | Yes | Valid values: 0 (Pulsar), 1 (RocketMQ).Note: This field may return null, indicating that no valid values can be obtained. |
cmq TransactionPolicy
Used by actions: DescribeCmqQueueDetail, DescribeCmqQueues.
Name | Type | Description |
---|---|---|
FirstQueryInterval | Integer | First lookback time. Note: this field may return null, indicating that no valid values can be obtained. |
MaxQueryCount | Integer | Maximum number of queries. Note: this field may return null, indicating that no valid values can be obtained. |
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. |
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. |
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: u200dThis field may return null, indicating that no valid values can be obtained. |
Set of environment roles
Used by actions: DescribeEnvironmentRoles.
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. |
Relationship between the namespaces that are bound in batches and role permissions
Used by actions: CreateRole.
Name | Type | Required | Description |
---|---|---|---|
EnvironmentId | String | Yes | The IDs of the bound namespaces cannot be delicate and the namespaces must contain resources Note: u200dThis 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: u200dThis field may return null, indicating that no valid values can be obtained. |
Filter parameter
Used by actions: DescribeClusters, DescribeCmqQueues, DescribeCmqTopics, DescribeEnvironmentRoles, DescribeEnvironments, DescribePublishers, DescribePulsarProInstances, DescribeRabbitMQNodeList, DescribeRabbitMQVipInstances, DescribeRabbitMQVirtualHost, DescribeRocketMQClusters, DescribeRocketMQVipInstances, DescribeRoles, DescribeTopics.
Name | Type | Required | Description |
---|---|---|---|
Name | String | No | Filter parameter name |
Values | Array of String | No | Value |
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. |
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 |
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. |
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. |
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 |
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: u200dThis field may return null, indicating that no valid values can be obtained. |
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. |
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 |
TDMQ for 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 Note: This field may return null, indicating that no valid value 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. |
TDMQ for RabbitMQ exclusive vhost
Used by actions: DescribeRabbitMQVirtualHostList.
Name | Type | Description |
---|---|---|
VirtualHostName | String | Vhost name Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Description | String | Vhost description Note: u200dThis field may return null, indicating that no valid values can be obtained. |
TDMQ for RabbitMQ user entity details
Used by actions: DescribeRabbitMQUser.
Name | Type | Description |
---|---|---|
InstanceId | String | Cluster instance ID |
User | String | Username, which is used for login. |
Password | String | Password, which is used for login. |
Description | String | User description Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Tags | Array of String | User tag, which defines a user's permission scope for accessing RabbitMQ Managementu200d. Note: u200dThis field may return null, indicating that no valid values can be obtained. |
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). |
TDMQ for RabbitMQ exclusive instance information
Used by actions: DescribeRabbitMQVipInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
InstanceName | String | Instance name |
InstanceVersion | String | Instance version Note: This field may return null, indicating that no valid value can be obtained. |
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 Note: This field may return null, indicating that no valid value can be obtained. |
SpecName | String | Instance specification ID |
ExceptionInformation | String | Cluster exception 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. |
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 Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Tags | Array of String | Vhost tag Note: u200dThis field may return null, indicating that no valid values can be obtained. |
CreateTime | String | Creation time Note: u200dThis field may return null, indicating that no valid values can be obtained. |
ModifyTime | String | Modification time Note: u200dThis field may return null, indicating that no valid values can be obtained. |
VirtualHostStatistics | RabbitMQVirtualHostStatistics | Statistics of vhost overview Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Status | String | |
MessageHeapCount | Integer | |
MessageRateIn | Float | |
MessageRateOut | Float |
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 |
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 |
RocketMQ cluster configuration
Used by actions: DescribeRocketMQCluster, DescribeRocketMQClusters.
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 |
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. |
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. |
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: u200dThis field may return null, indicating that no valid values can be obtained. |
HttpInternalEndpoint | String | Internal HTTP access address Note: u200dThis field may return null, indicating that no valid values can be obtained. |
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 |
RocketMQ consumer group information
Used by actions: DescribeRocketMQGroups.
Name | Type | Description |
---|---|---|
Name | String | Consumer group name. |
ConsumerNum | Integer | The number of online consumers. |
TPS | Integer | Consumption TPS. |
TotalAccumulative | Integer | The total number of heaped messages. |
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. |
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 |
TDMQ for RocketMQ message trace information
Used by actions: DescribeRocketMQMsg.
Name | Type | Description |
---|---|---|
Group | String | Consumer group |
ConsumeStatus | String | Consumption status |
TrackType | String | Message trace type |
ExceptionDesc | String | Exception information Note: u200dThis field may return null, indicating that no valid values can be obtained. |
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: u200dThis field may return null, indicating that no valid values can be obtained. |
RocketMQ topic information
Used by actions: 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. |
TDMQ for RocketMQ topic distribution
Used by actions: DescribeRocketMQVipInstanceDetail.
Name | Type | Description |
---|---|---|
TopicType | String | Topic type |
Count | Integer | Number of topics |
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 Note: This field may return null, indicating that no valid values can be obtained. |
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 Note: This field may return null, indicating that no valid values can be obtained. |
SpecName | String | Instance specification ID |
MaxRetention | Integer | The maximum message retention period in hours Note: u200dThis field may return null, indicating that no valid values can be obtained. |
MinRetention | Integer | The minimum message retention period in hours Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Retention | Integer | Instance message retention period in hours Note: u200dThis field may return null, indicating that no valid values can be obtained. |
Role instance
Used by actions: 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. |
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 . |
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. |
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. |
Type of the tag key/value
Used by actions: CreateCluster, CreateCmqQueue, CreateCmqTopic, DescribeClusterDetail, DescribeClusters, DescribeCmqQueueDetail, DescribeCmqQueues, DescribeCmqTopicDetail, DescribeCmqTopics.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Value of the tag key |
TagValue | String | Yes | Value of the tag value |
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-partitioned1 : Non-persistent and partitioned2 : Persistent and non-partitioned3 : Persistent and partitionedNote: This field may return null, indicating that no valid values can be obtained. |
Topic's key information
Used by actions: DeleteTopics.
Name | Type | Required | Description |
---|---|---|---|
EnvironmentId | String | Yes | Environment (namespace) name. |
TopicName | String | Yes | Topic name. |
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. |
VPC configuration information
Used by actions: DescribeRocketMQCluster, DescribeRocketMQVipInstanceDetail.
Name | Type | Required | Description |
---|---|---|---|
VpcId | String | Yes | VPC ID |
SubnetId | String | Yes | Subnet ID |
本页内容是否解决了您的问题?