History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
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. |
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 |
Query filter.
Used by actions: DescribeUserList.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter criterion name |
| Values | Array of String | Yes | Filter criterion value |
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 |
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. |
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. |
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. |
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
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. |
Message enrichment rule priority.
Used by actions: UpdateMessageEnrichmentRulePriority.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | Integer | Yes | Message enrichment rule id. |
| Priority | Integer | Yes | Priority |
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 data
Used by actions: CreateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag name. |
| TagValue | String | Yes | Tag value |
Returned mapping structure.
Used by actions: DescribeMessageDetails.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | key |
| Value | String | No | value |
VPC information.
Used by actions: CreateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| VpcId | String | No | VPC ID |
| SubnetId | String | No | Subnet ID. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários