Domain name for API request: trro.intl.tencentcloudapi.com.
This API is used to get specified device information.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDeviceInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2022-03-25. |
| Region | No | String | Common Params. This parameter is not required. |
| ProjectId | Yes | String | Project id to which the target device belongs. |
| DeviceId | Yes | String | Target device id. |
| Parameter Name | Type | Description |
|---|---|---|
| DeviceName | String | Device name. |
| DeviceType | String | Device type: "field" specifies on-site devices (controlled party), and "remote" specifies remote devices (controlling party). |
| DeviceStatus | String | Device status: offline means offline, ready means online and ready, connected means in session. |
| LastReportTime | Timestamp ISO8601 | Last updated time of device status. |
| ModifyTime | Timestamp ISO8601 | Modification time of device information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: trro.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceInfo
<Common request parameters>
{
"ProjectId": "f3glr49ry0i0xlm7",
"DeviceId": "test1"
}
{
"Response": {
"DeviceName": "test device1",
"LastReportTime": "2022-03-22T09:00:00+08:00",
"DeviceStatus": "offline",
"DeviceType": "field",
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
"ModifyTime": "2022-03-22T08:00:00+08:00"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Missing required parameters. |
| OperationDenied | Operation denied. |
피드백