- Release Notes and Announcements
- Product Introduction
- Getting Started
- Console Guide
- Product Management
- Rule Engine
- Overview
- Data Processing
- Rule Function
- Data Forwarding to Another Topic
- Data Forwarding to Third-Party Service
- Data Forwarding to CKafka
- Data Forwarding to TDMQ
- Data Forwarding to CTSDB
- Data Forwarding to TencentDB for MySQL
- Data Forwarding to TencentDB for MongoDB
- Data Forwarding to Tencent CloudBase
- Data Forwarding to TDSQL for MySQL
- Sub-account Access to IoT Hub
- Firmware Upgrade
- Resource Management
- Certificate Management
- Developer Manual
- API Documentation
- Device Connection Manual
- FAQs
- IoT Hub Policy
- Glossary
- Release Notes and Announcements
- Product Introduction
- Getting Started
- Console Guide
- Product Management
- Rule Engine
- Overview
- Data Processing
- Rule Function
- Data Forwarding to Another Topic
- Data Forwarding to Third-Party Service
- Data Forwarding to CKafka
- Data Forwarding to TDMQ
- Data Forwarding to CTSDB
- Data Forwarding to TencentDB for MySQL
- Data Forwarding to TencentDB for MongoDB
- Data Forwarding to Tencent CloudBase
- Data Forwarding to TDSQL for MySQL
- Sub-account Access to IoT Hub
- Firmware Upgrade
- Resource Management
- Certificate Management
- Developer Manual
- API Documentation
- Device Connection Manual
- FAQs
- IoT Hub Policy
- Glossary
Attribute
Device attributes
Used by actions: CreateDevice.
| Name | Type | Required | Description |
|---|---|---|---|
| Tags | Array of DeviceTag | No | Attribute list |
BindProductInfo
Sub-product information
Used by actions: DescribePrivateCABindedProducts.
| Name | Type | Description |
|---|---|---|
| ProductId | String | Product ID |
| ProductName | String | Product name |
CertInfo
X.509 certificate information
Used by actions: DescribePrivateCA, DescribePrivateCAs, DescribeProductCA.
| Name | Type | Required | Description |
|---|---|---|---|
| CertName | String | Yes | Certificate name |
| CertSN | String | Yes | Hex sequence number of a certificate |
| IssuerName | String | Yes | Certificate issuer |
| Subject | String | Yes | Certificate subject |
| CreateTime | Integer | Yes | Certificate creation time (timestamp in milliseconds) |
| EffectiveTime | Integer | Yes | Certificate effective time (timestamp in milliseconds) |
| ExpireTime | Integer | Yes | Certificate expiration time (timestamp in milliseconds) |
| CertText | String | Yes | X.509 certificate content |
DeviceInfo
Device details
Used by actions: DescribeDevices.
| Name | Type | Description |
|---|---|---|
| DeviceName | String | Device name |
| Online | Integer | Whether the device is online. 0: offline; 1: online |
| LoginTime | Integer | Device login time |
| Version | String | Device version |
| DeviceCert | String | Device certificate, which is returned for devices that use certificates for authentication |
| DevicePsk | String | Device key, which is returned for devices that use keys for authentication |
| Tags | Array of DeviceTag | Device attribute |
| DeviceType | Integer | Device type |
| Imei | String | International Mobile Equipment Identity (IMEI) |
| Isp | Integer | ISP |
| NbiotDeviceID | String | Device ID at the NB-IoT ISP |
| ConnIP | Integer | IP address |
| LastUpdateTime | Integer | Last updated time of the device |
| LoraDevEui | String | DevEUI of a LoRa device |
| LoraMoteType | Integer | MoteType of a LoRa device |
| FirstOnlineTime | Integer | The first time when the device went online Note: this field may return null, indicating that no valid value is obtained. |
| LastOfflineTime | Integer | The last time when the device went offline Note: this field may return null, indicating that no valid value is obtained. |
| CreateTime | Integer | Device creation time Note: this field may return null, indicating that no valid value is obtained. |
| LogLevel | Integer | Device log level Note: this field may return null, indicating that no valid value is obtained. |
| CertState | Integer | Whether the device certificate has been obtained. 0: no; 1: yesNote: this field may return null, indicating that no valid value is obtained. |
| EnableState | Integer | Whether the device is enabled. 0: disabled; 1: enabledNote: this field may return null, indicating that no valid value is obtained. |
| Labels | Array of DeviceLabel | Device tags Note: this field may return null, indicating that no valid value is obtained. |
| ClientIP | String | IP address of the MQTT client Note: this field may return null, indicating that no valid value is obtained. |
| FirmwareUpdateTime | Integer | Time of last OTA update Note: this field may return null, indicating that no valid value is obtained. |
DeviceLabel
Device tags
Used by actions: DescribeDevice, DescribeDevices.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Tag key |
| Value | String | Yes | Tag value |
DeviceTag
Device attribute
Used by actions: CreateDevice, DescribeDevice, DescribeDevices.
| Name | Type | Required | Description |
|---|---|---|---|
| Tag | String | Yes | Attribute name |
| Type | Integer | Yes | Attribute value type. 1: integer; 2: string |
| Value | String | Yes | Attribute value |
| Name | String | No | Attribute description Note: this field may return null, indicating that no valid value is obtained. |
ProductInfo
Product details
Used by actions: DescribeProducts.
| Name | Type | Description |
|---|---|---|
| ProductId | String | Product ID |
| ProductName | String | Product name |
| ProductMetadata | ProductMetadata | Product metadata |
| ProductProperties | ProductProperties | Product properties |
ProductMetadata
Product metadata
Used by actions: DescribeProduct, DescribeProducts.
| Name | Type | Description |
|---|---|---|
| CreationDate | Integer | Product creation time |
ProductProperties
Product properties
Used by actions: CreateProduct, DescribeProduct, DescribeProducts.
| Name | Type | Required | Description |
|---|---|---|---|
| ProductDescription | String | No | Product description |
| EncryptionType | String | No | Authentication type. 1 (default): certificate; 2: signature |
| Region | String | No | Product region. Valid value: gz (Guangzhou) |
| ProductType | Integer | No | Product type. Valid values:0 (default): general; 2: NB-IoT; 3: LoRa gateway; 4: LoRa; 5: general gateway |
| Format | String | No | Data format. Valid values: json (default), custom |
| Platform | String | No | Platform of the product. Default value: 0 |
| Appeui | String | No | AppEUI at the LoRa product operator, required only for LoRa products |
| ModelId | String | No | ID of the Thing Specification Language (TSL) model bound to the product. -1 means no models are bound. |
| ModelName | String | No | Name of the TSL model bound to the product |
| ProductKey | String | No | Product key, which is specific to suite products |
| RegisterType | Integer | No | Dynamic registration type. 0: disable; 1: preset device names; 2: generate device names dynamically |
| ProductSecret | String | No | Dynamic registration product key |
| RegisterLimit | Integer | No | The maximum number of devices that can be dynamically created when RegisterType is set to 2 |
| OriginProductId | String | No | Original product ID of a transferred product. This parameter is empty for products that are not transferred. |
| PrivateCAName | String | No | Private CA certificate name |
| OriginUserId | Integer | No | Original user ID of a transferred product. This parameter is empty for products that are not transferred. |
Yes
No
Was this page helpful?