查詢?cè)O(shè)備列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vs:DescribeDevices | get |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 否 | 設(shè)備 ID。 說(shuō)明
支持多個(gè),用英文逗號(hào)(,)分隔。
| 348*****380-cn-qingdao |
Name | string | 否 | 設(shè)備名稱。 說(shuō)明
支持多個(gè),用英文逗號(hào)(,)分隔。
| 攝像頭A |
Type | string | 否 | 按設(shè)備類型查詢。取值范圍:
| ipc |
GroupId | string | 否 | 按設(shè)備所屬空間 ID 查詢。 | 348*****174-cn-qingdao |
ParentId | string | 否 | 按設(shè)備所屬上級(jí)設(shè)備 ID 查詢。 | 399*****774-cn-qingdao |
DirectoryId | string | 否 | 按設(shè)備所屬目錄 ID 查詢。 | 399*****488-cn-qingdao |
GbId | string | 否 | 按設(shè)備國(guó)標(biāo) ID 查詢。 | 310000000****0000002 |
Dsn | string | 否 | 設(shè)備序列號(hào),唯一標(biāo)識(shí)。 | 7D0*****4C0 |
Status | string | 否 | 按設(shè)備狀態(tài)查詢。 | on |
Vendor | string | 否 | 按設(shè)備廠商查詢。 | 8yd*****qem |
SortBy | string | 否 | 按給定字段排序。取值: 說(shuō)明
id(默認(rèn))
| id |
SortDirection | string | 否 | 排序方式。取值范圍:
| asc |
PageSize | long | 否 | 分頁(yè)大小,默認(rèn)值:20。 | 20 |
PageNum | long | 否 | 第幾個(gè)分頁(yè),默認(rèn)值:1。 | 1 |
IncludeStats | boolean | 否 | 是否返回流統(tǒng)計(jì)信息,默認(rèn)值:false。 | false |
IncludeDirectory | boolean | 否 | 是否返回目錄信息,默認(rèn)值:false。 | false |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 77,
"PageCount": 5,
"Devices": [
{
"Type": "ipc",
"Status": "on",
"AlarmMethod": "0",
"Dsn": "7D0*****4C0",
"Port": 8080,
"PosInterval": 300,
"AutoDirectory": true,
"ParentId": "3238848****092995",
"Password": "admin",
"AutoPos": false,
"Params": "{}",
"Description": "xxx路口攝像頭",
"Enabled": true,
"Name": "xxx路口攝像頭",
"ChannelSyncTime": "2019-02-28T17:01:17Z",
"CreatedTime": "2019-02-28T17:00:17Z",
"DirectoryId": "399*****488-cn-qingdao",
"RegisteredTime": "2019-02-28T17:00:17Z",
"Protocol": "gb28181",
"Ip": "10.10.10.10",
"Url": "rtmp://xxx/xxx",
"AutoStart": false,
"Vendor": "公司A",
"GbId": "310000000****0000002",
"GroupId": "348*****174-cn-qingdao",
"Longitude": "45.00",
"Latitude": "119.20",
"Id": "348*****380-cn-qingdao",
"Username": "admin",
"Stats": {
"FailedNum": 0,
"StreamNum": 0,
"ChannelNum": 0,
"OnlineNum": 0,
"OfflineNum": 0
},
"Directory": {
"ParentId": "399*****774-cn-qingdao",
"Description": "目錄1",
"GroupId": "348*****174-cn-qingdao",
"Name": "目錄1",
"CreatedTime": "2019-02-28T17:00:17Z",
"Id": "399*****488-cn-qingdao"
}
}
]
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。