Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to query detailed information of a device.
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: DescribeUserDevice. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| DeviceId | Yes | String | Device ID (obtain from the ListDevices api) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DescribeDeviceData | Returned result |
| 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. |
ok
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserDevice
<Common request parameters>
{
"DeviceId": "da238a8c-****-4a5b-****-************"
}{
"Response": {
"Data": {
"AccessProtocol": 1,
"ClusterId": "********-****-****-****-************",
"ClusterName": "",
"Code": "2*****vkVe",
"Description": "",
"GatewayId": "",
"GatewayName": "",
"DeviceId": "da238a8c-****-4a5b-****-************",
"Ip": "",
"Manufacturer": "",
"Name": "iss-qta-dont-delete",
"OrganizationId": "22",
"Password": "",
"Port": 0,
"ProtocolType": 0,
"ProtocolTypeName": "",
"PushStreamUrl": "rtmp://81.**.54.**/live/2*****4vkVe",
"Region": "",
"SipDomain": "",
"SipId": "",
"SipIp": "",
"SipPort": 0,
"Status": 0,
"TransportProtocol": 0,
"Type": 1,
"Username": ""
},
"RequestId": "c3e6cbee-7a30-49b0-8415-af3cc46fe257"
}
}Invalid device Id
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserDevice
<Common request parameters>
{
"DeviceId": "AoiPcid9U"
}{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidDeviceId",
"Message": "Invalid device Id"
},
"RequestId": "97694623-ae7d-435c-aff7-f5a051fe9474"
}
}POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserDevice
<Common request parameters>
{
"DeviceId": "66666666-****-****-****-************"
}{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidDeviceId",
"Message": "Invalid device Id"
},
"RequestId": "c3c7c853-e5cf-4829-87f8-375b0623d750"
}
}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 |
| InvalidParameter | Invalid input parameter |
| InvalidParameterValue.InvalidDeviceId | Invalid device ID |
| ResourceNotFound | Resource does not exist. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan