tencent cloud

APIs

DocumentaçãoAPIsTDMQ for MQTTData Types

Data Types

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-12 11:31:58

AuthorizationPolicyItem

AuthorizationPolicyItem

Used by actions: DescribeAuthorizationPolicies.

Name Type Description
Id Integer Policy rule ID.
InstanceId String MQTT cluster ID.
PolicyName String Specifies the policy rule name.
Version Integer Rule syntax version. currently only support 1. defaults to 1.
Priority Integer Policy priority. a smaller priority ID indicates the policy takes effect with higher priority. see data plane authorization policy description.
Effect String Specifies the decision.
allow specifies permission for access requests from devices that match this policy.
deny: denies access requests to the device that override the policy.
Refer to the data plane authorization policy description.
Actions String Operation.
Specifies the connection.
Publishes an mqtt message.
Sub. specifies the subscription to mqtt messages.
Refer to the data plane authorization policy description.
Resources String Resource. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).
ClientId String Specifies the device ID for connection. refer to the data plane authorization policy description.
Username String Condition - username. refer to the data plane authorization policy description.
Ip String Specifies the client IP address. see the data plane authorization policy description.
Qos String Condition - service quality. see the data plane authorization policy description (https://www.tencentcloud.com/document/product/1778/109715?from_cn_redirect=1).
Retain Integer Condition - message retention. refer to the data plane authorization policy description.
Indicates the match of retain messages.
2: indicates non-retain messages.
3: indicates matching retain and non-retain messages.
Remark String Specifies the remark with length not exceeding 128 characters.
CreatedTime Integer Creation time. millisecond-level timestamp.
UpdateTime Integer Update time. millisecond-level timestamp.

AuthorizationPolicyPriority

Rule priority.

Used by actions: UpdateAuthorizationPolicyPriority.

Name Type Required Description
Id Integer Yes Specifies the authorization policy rule id, which can be obtained from the DescribeAuthorizationPolicies api (https://www.tencentcloud.com/document/api/1778/111074?from_cn_redirect=1).
Priority Integer Yes Priority

DeviceCertificateItem

Device certificate information

Used by actions: DescribeDeviceCertificates.

Name Type Description
ClientId String Client ID.
DeviceCertificate String device certificate
DeviceCertificateSn String Device certificate SN serial number, used for unique identification of a device certificate
DeviceCertificateCn String Device certificate Cn
CaSn String Serial number of the CA cert that issued the cert
Format String Certificate format, currently only support PEM
Status String Device certificate status
ACTIVE: Activate
INACTIVE: Inactive
REVOKED: Revoked
PENDING_ACTIVATION: To be activated.
OrganizationalUnit String Organization unit
LastActivationTime Integer Last activation time, millisecond-level timestamp.
LastInactivationTime Integer Last cancellation activation time, millisecond-level timestamp.
CreatedTime Integer createTime, millisecond-level timestamp.
UpdateTime Integer Update time, millisecond-level timestamp.
CertificateSource String Certificate source:
API, Manual Registration
Automatic JITP registration
NotAfterTime Integer Certificate expiration date, millisecond-level timestamp.
NotBeforeTime Integer Start date when the certificate takes effect, millisecond-level timestamp.

DeviceIdentityItem

Device identifier list

Used by actions: DescribeDeviceIdentities.

Name Type Description
InstanceId String Cluster ID.
DeviceId String Device ID
Status Integer 1: ENABLED - Available 2: DISABLED - Unavailable
PrimaryKey String Primary signature key. Automatically generated by the system if not provided.
SecondaryKey String Secondary signature key. Automatically generated by the system if not passed.
CreatedTime Integer Creation time.
PropagatingProperties Array of PropagatingProperty Spread attribute list

Filter

Query filter.

Used by actions: DescribeDeviceCertificates, DescribeInstanceList, DescribeUserList.

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

IpRule

IP rules

Used by actions: CreateInstance.

Name Type Required Description
Ip String Yes IP address.
Allow Boolean Yes Currently only support allowed by default.
Remark String Yes Remarks

MQTTClientInfo

MQTT client information.

Used by actions: DescribeClientList.

Name Type Description
ClientId String Client ID
ClientAddress String Client network address.
ProtocolVersion Integer MQTT protocol version.
3: indicates MQTT version 3.1.
4: indicates MQTT 3.1.1.
5: indicates the MQTT 5.0 protocol.
Keepalive Integer Keep-alive duration. Unit: second.
ConnectionStatus String Connection status. CONNECTED: connected; DISCONNECTED: not connected.
CreateTime Integer Client creation time. millisecond-level timestamp.
ConnectTime Integer Last connection establishment time. millisecond-level timestamp.
DisconnectTime Integer Last disconnection time, only applicable to persistent sessions (cleanSession=false) and when the client is currently disconnected, millisecond-level timestamp.
MQTTClientSubscriptions Array of MQTTClientSubscription Client subscription list.

MQTTClientSubscription

MQTT subscription relationship.

Used by actions: DescribeClientList.

Name Type Description
TopicFilter String Subscribed topic.
Qos Integer Service quality grade.
Up to once.
At least once.
Exactly once.
Lag Integer Indicates the heaped messages.
Inflight Integer Unconfirmed delivery count.
UserProperties Array of SubscriptionUserProperty Describes the user attribute.

MQTTInstanceItem

MQTT instance information.

Used by actions: DescribeInstanceList.

Name Type Description
InstanceId String Instance ID.
InstanceName String Instance name.
Version String Instance version
InstanceType String Instance type
BASIC, basic version
PRO, Professional Edition
PLATINUM, platinum version
InstanceStatus String Instance status
RUNNING: running.
MAINTAINING
ABNORMAL
OVERDUE, arrears
CREATING
MODIFYING, Modifying configuration in progress
Creation failed
MODIFY_FAILURE, configuration change failed
DELETING: Deleting
TopicNumLimit Integer Maximum number of instance topics
Remark String Remarks
TopicNum Integer Number of topics
SkuCode String Product specification
TpsLimit Integer Elastic TPS throttle value
CreateTime Integer Creation time, with a millisecond-level timestamp.
MaxSubscriptionPerClient Integer Maximum number of subscriptions for a single client
ClientNumLimit Integer Maximum number of client connections.
RenewFlag Integer Whether it is automatically renewed. Only applicable to monthly subscription clusters.
1: Automatic renewal
Non-automatic renewal
PayMode String Billing mode, POSTPAID, pay-as-you-go PREPAID, annual/monthly subscription
ExpiryTime Integer Expiry time, millisecond-level timestamp
DestroyTime Integer Predestruction time, millisecond-level timestamp
AuthorizationPolicyLimit Integer Number of authorization rule entries limit
MaxCaNum Integer Maximum ca quota
MaxSubscription Integer Maximum number of subscriptions
SharedSubscriptionGroupLimit Integer Maximum limit of shared subscription groups
MaxTopicFilterPerSharedSubscriptionGroup Integer Number limit of TopicFilter in one shared subscription group
AutoSubscriptionPolicyLimit Integer Limit on number of auto subscription rules
MaxTopicFilterPerAutoSubscriptionPolicy Integer Number limit of TopicFilter in a single auto subscription rule

MQTTMessage

MQTT message.

Used by actions: DescribeMessageByTopic.

Name Type Description
MessageId String Message ID
ClientId String Client Id of the message sender.
Qos String Message service quality grade.
StoreTimestamp Integer Message storage time on the server. millisecond-level timestamp.
OriginTopic String Specifies the source topic.

MQTTUserItem

MQTT cluster user information.

Used by actions: DescribeUserList.

Name Type Description
Username String Username.
Password String Password.
Remark String Remarks
CreatedTime Integer Creation time. millisecond-level timestamp.
ModifiedTime Integer Modification time. millisecond-level timestamp.

MessageEnrichmentRuleItem

MessageEnrichmentRuleItem

Used by actions: DescribeMessageEnrichmentRules.

Name Type Description
Id Integer Rule ID.
InstanceId String MQTT cluster ID.
RuleName String Specifies the rule name.
Condition String Rule matching conditions, in JSON format, must be Base64-encoded.
Specifies the client id, username, and topic. example: {"clientId":"client-1","username":"client-1","topic":"home/room1"}.
Specifies the Base64-encoded string "eyJjbGllbnRJZCI6ImNsaWVudC0xIiwidXNlcm5hbWUiOiJjbGllbnQtMSIsInRvcGljIjoiaG9tZS9yb29tMSJ9".
Actions String Specifies the action of rule execution in JSON format, which must be Base64 encoded.
Creating a Billing Resource Order
{"messageExpiryInterval":360,"response Topic":"replies/devices/${clientid}","correlationData":"${traceid}","userProperty":[{"key":"trace-id","value":"${traceid}"},{"key":"data-source","value":"rule-engine"}]}
Specifies the BASE64-encoded string "eyJtZXNzYWdlRXhwaXJ5SW50ZXJ2YWwiOjM2MCwicmVzcG9uc2UgVG9waWMiOiJyZXBsaWVzL2RldmljZXMvJHtjbGllbnRpZH0iLCJjb3JyZWxhdGlvbkRhdGEiOiIke3RyYWNlaWR9IiwidXNlclByb3BlcnR5IjpbeyJrZXkiOiJ0cmFjZS1pZCIsInZhbHVlIjoiJHt0cmFjZWlkfSJ9LHsia2V5IjoiZGF0YS1zb3VyY2UiLCJ2YWx1ZSI6InJ1bGUtZW5naW5lIn1dfQ==".
Priority Integer Rule priority. a smaller number indicates a higher priority. high priority overrides low priority. the UserProperty field will be merged.
Status Integer Rule status. valid values: 0 (undefined), 1 (activate), 2 (deactivate). default: deactivate.
Remark String Remarks
CreatedTime Integer Creation time. millisecond-level timestamp.
UpdateTime Integer Update time. millisecond-level timestamp.

MessageEnrichmentRulePriority

Message enrichment rule priority.

Used by actions: UpdateMessageEnrichmentRulePriority.

Name Type Required Description
Id Integer Yes Message enrichment rule id.
Priority Integer Yes Priority

PriceTag

Price tag information

Used by actions: DescribeProductSKUList.

Name Type Description
Name String Billing name refers to the category of billable items for specifications. The pricing name for specific specifications can be found in the returned results of the DescribeProductSKUList API.
Category String Billing category, pricing name subclass. For the billing category of specific specifications, see the returned results in DescribeProductSKUList API.
Code String Billing item tag is a subproject of the billing Category under the pricing Name (Name), representing a specific charge. For the billing item tag of the specification, see
DescribeProductSKUList API returned results.
Step Integer Billing step length indicates the billing quantity of the billing item tag (Code) under the billing category (Category) for the pricing name (Name). For the field value of specific specifications, refer to DescribeProductSKUList API.

ProductSkuItem

MQTT ProductSkuItem

Used by actions: DescribeProductSKUList.

Name Type Description
InstanceType String Specification type
BASIC: Basic Edition.
PRO: Professional Edition
PLATINUM: Platinum version
SkuCode String Specification code
OnSale Boolean whether required or not
1: available for sale
0: unsellable
TopicNumLimit Integer Limit on the number of topics.
TpsLimit Integer Sum of the quantity of messages produced and consumed per second in an MQTT cluster.
ClientNumLimit Integer Number of client connections
MaxSubscriptionPerClient Integer Maximum number of subscriptions for a single client
AuthorizationPolicyLimit Integer Number of authorization rules
PriceTags Array of PriceTag Billing item information

PropagatingProperty

undefined

Used by actions: CreateDeviceIdentity, DescribeDeviceIdentities, DescribeDeviceIdentity, ModifyDeviceIdentity.

Name Type Required Description
Key String Yes propagating properties key
Value String Yes propagating properties value

SharedGroup

Shared subscription group

Used by actions: DescribeSharedSubscriptionGroups.

Name Type Description
InstanceId String Tencent Cloud MQTT instance ID
SharedName String Shared subscription group name
LbStrategy Integer Shared group load balancing strategy 1.RANDOM 2.HASH_PARTITION
ExpiryInterval Integer Takes effect under the HASH_PARTITION policy. It indicates the delay time when a Client disconnects or a new Client comes online to join the subscription group for consumption.
Range: 0–600 seconds
Remark String Remark, length not exceeding 128 characters.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime Integer createTime, millisecond-level timestamp.
UpdateTime Integer Last update time, millisecond-level timestamp.

SharedSubscriptionClient

Shared subscription group client

Used by actions: DescribeSharedSubscriptionClient.

Name Type Description
ClientId String Client ID
SharedName String Shared subscription group name
TopicFilter String Expression list of subscriptions under the shared group
Online Boolean Online status

SubscriptionUserProperty

Subscribed UserProperty structure.

Used by actions: DescribeClientList.

Name Type Description
Key String Specifies the key of the UserProperty for subscription.
Value String Specifies the value of the UserProperty for subscription.

Tag

Tag data

Used by actions: CreateInstance.

Name Type Required Description
TagKey String Yes Tag name.
TagValue String Yes Tag value

TagFilter

Tag filter

Used by actions: DescribeInstanceList.

Name Type Required Description
TagKey String No Tag key name
TagValues Array of String No Tag key name

UserProperty

Returned mapping structure.

Used by actions: DescribeMessageDetails.

Name Type Required Description
Key String No key
Value String No value

VpcInfo

VPC information.

Used by actions: CreateInstance.

Name Type Required Description
VpcId String No VPC ID
SubnetId String No Subnet ID.
Anterior: CreateMessageEnrichmentRulePróximo: Error Codes

Ajuda e Suporte

Esta página foi útil?

comentários