Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to obtain the device list under the corresponding organization.
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: ListDevices. |
| 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. |
| OrganizationId | Yes | String | Organization ID |
| IsContainSubLevel | No | Boolean | Whether to obtain the device list of the current level and sub-levels. Default value: false. |
| IsContainUser | No | Boolean | Whether the devices already associated with the current user are included. Default value: false. |
| AccessProtocol | No | Integer | Device access protocol. 1: RTMP, 2: GB, 3: GW, 4: IVCP (private protocol) |
| Type | No | Integer | Device type. 1: IPC, 2: NVR |
| Status | No | Integer | Device status. 0: unregistered; 1: online; 2: offline; 3: disabled. |
| ClusterId | No | String | Service node ID |
| Keyword | No | String | Keyword for fuzzy search of devices |
| CurrentUin | No | Integer | Uin of the current user |
| PageNumber | No | Integer | Page number. Default value: 1. |
| PageSize | No | Integer | Number of items per page. Default value: 20. Maximum: 10000 per page. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of ListDeviceInfo | Device list details |
| TotalCount | Integer | Total number of devices |
| 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. |
Invalid device access protocol
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDevices
<Common request parameters>
{
"OrganizationId": "191",
"AccessProtocol": 4
}{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidAccessProtocol",
"Message": "Invalid device access protocol"
},
"RequestId": "cb4884f8-f00e-4e2f-a867-49a4d805960f"
}
}None
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDevices
<Common request parameters>
{
"OrganizationId": "191"
}{
"Response": {
"Data": [
{
"AccessProtocol": 2,
"ChannelNum": 1,
"ClusterId": "4************************0",
"ClusterName": "Shanghai Zone 1",
"Code": "6************************4",
"Description": "",
"DeviceId": "2************************8",
"Name": "gb12138",
"OrganizationId": "191",
"Password": "30******96",
"Status": 2,
"TransportProtocol": 1,
"Type": 2
}
],
"RequestId": "d217472e-ca9b-4a4d-bb4b-c45326ce8e3e",
"TotalCount": 1
}
}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 |
| InvalidParameterValue.InvalidAccessProtocol | Invalid device access protocol. |
| InvalidParameterValue.InvalidClusterId | Invalid cluster ID. The length or content does not conform to rules. |
| InvalidParameterValue.InvalidDeviceStatus | Invalid device status |
| InvalidParameterValue.InvalidDeviceType | Invalid device type |
| InvalidParameterValue.InvalidKeyword | Invalid keyword |
| InvalidParameterValue.InvalidOrganizationId | Invalid organization ID |
| InvalidParameterValue.InvalidPageNumber | Invalid PageNumber |
| InvalidParameterValue.InvalidPageSize | Invalid PageSize |
文档反馈