Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to query the channel list under the organizational unit directory.
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: ListOrganizationChannels. |
| 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 |
| PageSize | Yes | Integer | Maximum number of items per page |
| PageNumber | Yes | Integer | Which page. |
| DeviceName | No | String | Query condition. Query by device name. Only one query condition can take effect at a time. Length not exceeding 32 bytes. |
| ChannelName | No | String | Query condition. Proceed to query by channel name. Only one query condition can take effect at a time. Length not exceeding 32 bytes. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | ListOrganizationChannelsData | 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. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListOrganizationChannels
<Common request parameters>
{
"OrganizationId": "182",
"PageSize": 5,
"PageNumber": 1
}{
"Response": {
"Data": {
"List": [
{
"ChannelId": "000fb77b-f309-****-****-d4aff5503d70",
"ChannelName": "dev_1",
"DeviceId": "81b14b2d-f309-****-****-3d1a3c3f630f",
"DeviceName": "gb-device11814",
"InPlan": true
},
{
"ChannelId": "0020a697-f309-****-****-c836d9f95075",
"ChannelName": "dev_1",
"DeviceId": "c94a9cc1-ee07-****-******-c87b6065893d",
"DeviceName": "gb-device11820",
"InPlan": true
},
{
"ChannelId": "002b99cb-f309-****-****-fb573cc57ab8",
"ChannelName": "dev_1",
"DeviceId": "a7718b36-f309-****-****-b417bd2aa809",
"DeviceName": "gb-device3633",
"InPlan": true
},
{
"ChannelId": "15daac41-f309-****-****-0cadab7a6256",
"ChannelName": "PTZ03",
"DeviceId": "cae2132a-7edc-****-****-19cc90a61f06",
"DeviceName": "NVR-04",
"InPlan": true
},
{
"ChannelId": "222c9da5-*18b3-****-****-107c013b95a7",
"ChannelName": "PTZ09",
"DeviceId": "389708b2-708b-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
}
],
"PageNumber": 1,
"PageSize": 5,
"TotalCount": 13
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListOrganizationChannels
<Common request parameters>
{
"OrganizationId": "182",
"DeviceName": "SDK-NVR05",
"PageSize": 5,
"PageNumber": 1
}{
"Response": {
"Data": {
"List": [
{
"ChannelId": "222c9da5-3e06-****-****-107c013b95a7",
"ChannelName": "PTZ09",
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
},
{
"ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
"ChannelName": "11",
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
},
{
"ChannelId": "53ca64d3-9627-****-****-cea5122f6977",
"ChannelName": "PTZ03",
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
},
{
"ChannelId": "c80a0ebf-10ac-****-****-8083f18df240",
"ChannelName": "PTZ17",
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
}
],
"PageNumber": 1,
"PageSize": 4,
"TotalCount": 4
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListOrganizationChannels
<Common request parameters>
{
"OrganizationId": "182",
"ChannelName": "11",
"PageSize": 5,
"PageNumber": 1
}{
"Response": {
"Data": {
"List": [
{
"ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
"ChannelName": "11",
"DeviceId": "389708b2-bcbb-****-****-a61f528b2a15",
"DeviceName": "SDK-NVR05",
"InPlan": true
}
],
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 1
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}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.InvalidBodyFormat | Invalid message body format |
| InvalidParameterValue.EmptyName | Name cannot be empty |
| InvalidParameterValue.EmptyOrganizationId | Organization ID cannot be empty. |
| InvalidParameterValue.IllegalName | Name contains non-compliant characters (only Chinese, English, digits, _, and - are supported) |
| InvalidParameterValue.IllegalOrganizationId | Organization ID contains illegal characters |
| InvalidParameterValue.InvalidPageNumber | Invalid PageNumber |
| InvalidParameterValue.InvalidPageSize | Invalid PageSize |
| InvalidParameterValue.TooLongName | Name is too long |
| ResourceNotFound.OrganizationIdNotExist | Organization ID does not exist. |
피드백