Real-time Teleoperation
- Purchase Guide
- Development Guide
- Field Device SDK
- Remote Device SDK
- API Documentation
- Making API Requests
- Session APIs
- Authorization APIs
- Other APIs
- SDK and Demo Download
- FAQs
DescribeDeviceInfo
Last updated: 2025-02-17 15:36:42
1. API Description
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId | Yes | String | Project id to which the target device belongs. |
| DeviceId | Yes | String | Target device id. |
3. Output Parameters
| 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. |
4. Example
Example1 Getting Device Information Example
Input Example
POST / HTTP/1.1
Host: trro.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceInfo
<Common request parameters>
{
"ProjectId": "f3glr49ry0i0xlm7",
"DeviceId": "test1"
}
Output Example
{
"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"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No