獲取IPC設備信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeIpcs |
系統規定參數。取值：DescribeIpcs。 |
| PageNum | Long | 是 | 1 |
獲取第幾個分頁。 |
| PageSize | Long | 是 | 10 |
獲取的分頁大小。最大200 |
| ParentDeviceType | String | 否 | NVR |
IPC所屬的設備類型。枚舉值： IPC、NVR、ABOX。 填寫所屬設備類型時，會根據此字段過濾指定設備類型的IPC，或者NVR/ABOX的視頻通道。 如果不填，則返回所有。 |
| DeviceIdList | String | 否 | 100001****,100002****,100003**** |
IPC的ID列表，多個之間用逗號分隔。 CorpIdList，DeviceIdList， NvrIdList參數互斥；同時輸入時， DeviceIdList>NvrIdList>CorpIdList。 如果都不填，則獲取所有IPC。 |
| NvrIdList | String | 否 | 100001****,100002****,100003**** |
NVR的ID列表，多個之間用逗號分隔。 如果需要獲取NVR下的通道信息，請在這里填寫NVR的設備ID。 |
| CorpIdList | String | 否 | 100001****,100002****,100003**** |
項目ID列表，多個之間用逗號分隔。 如果需要獲取指定項目下的設備信息，請在這里填寫項目ID。 |
| DeviceFilter | String | 否 | 100001**** |
設備名稱或編號，用來過濾返回的結果，只有名稱或者編號包含指定字符串的結果才返回。 |
| DeviceStatus | String | 否 | 1 |
設備在線狀態： 1表示在線，0表示離線, 2表示待注冊 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 46329898-489C-4E63-9BA1-C1DA5C5D0986 |
請求ID |
| Code | String | 200 |
返回結果編碼 |
| Message | String | Success |
返回結果消息 |
| Data | Object |
返回結果 |
|
| TotalCount | Long | 32 |
設備總數量 |
| TotalPage | Long | 4 |
分頁總數量 |
| PageNum | Long | 1 |
返回第幾個分頁 |
| PageSize | Long | 10 |
分頁大小 |
| Records | Array of Record |
返回結果列表 |
|
| CorpId | String | 100001**** |
項目ID |
| ServerId | String | 330100990120**** |
設備接入的服務編碼，接入協議為GB28181時表示服務器國標ID |
| ServerIp | String | 192.168.XX.XX |
設備接入的服務器IP |
| ServerRealm | String | 2021**** |
接入服務器的域名，目前僅在國標協議中有效，您需要將其填寫到設備頁面中 |
| ServerPort | String | 5060 |
設備接入的服務器端口 |
| DeviceId | String | 33011012011327999**** |
設備ID |
| Password | String | ****** |
設備接入服務器的密碼 |
| DeviceName | String | example |
設備名稱 |
| DeviceAddress | String | 某地市 |
設備地址 |
| Longitude | String | 116.397128 |
經度 |
| Latitude | String | 39.916527 |
緯度 |
| DeviceDirection | String | 由內朝外 |
設備安裝方向。僅適用于IPC。 |
| DeviceSite | String | 大門門口 |
設備安裝點位，如大門門口 |
| DeviceResolution | String | 1920*1080 |
設備分辨率 |
| DeviceRate | String | 2048 |
設備碼率kbps |
| FrameRate | String | 25 |
設備支持的幀率。僅適用于IPC。 |
| GovLength | String | 50 |
I幀間隔。僅適用于IPC。 |
| EncodeFormat | String | 6 |
視頻或圖片格式。僅適用于IPC。 枚舉值： 3: MJPEG 6: H.264 13: H.265 默認6。 |
| AudioEnable | String | 1 |
是否開啟音頻。僅適用于IPC。 取值范圍：0 關閉； 1 打開。 |
| OSDTimeEnable | String | 1 |
是否在畫面上顯示時間。僅適用于IPC。 取值范圍：0 關閉； 1 打開。 |
| OSDTimeType | String | 1 |
時間顯示類型。僅適用于IPC。 取值范圍： 0：YYYY-MM-DD 星期W HH:MM:SS； 1：DD-MM-YYYY星期W HH:MM:SS； 2：YYYY年MM月DD日 星期W HH:MM:SS； 3：MM月DD日YYYY年 星期W HH:MM:SS； 4：YYYY-MM-DD |
| OSDTimeX | String | 99 |
時間戳X像素坐標（可選），以播放窗口左上角像素為原點，水平向右為正。僅適用于IPC。 |
| OSDTimeY | String | 1 |
時間戳Y像素坐標（可選），以播放窗口左上角像素為原點，豎直向下為正。僅適用于IPC。 |
| Vendor | String | 阿里云 |
設備產商 |
| DeviceType | String | IPC |
設備類型 |
| DeviceModel | String | ACube200-8 |
設備的型號 |
| InProtocol | String | GBT28181 |
設備接入協議 |
| DeviceSn | String | ca0e71642974**** |
設備序列號，即SN號。 |
| DatasourceType | String | VIDEO |
數據源類型：VIDEO（IPC、NVR通用數據類型）、PIC_VIDEO（阿里云定制ACube系列的數據類型）。 |
| DeviceSubType | String | 1 |
1：標清固定攝像機 2：標清云臺攝像機 3：高清固定攝像機 4：高清云臺攝像機 199：視圖庫攝像機 |
| DeviceIp | String | 192.168.XX.XX |
設備IP |
| DeviceStatus | String | 1 |
設備在線狀態： 1表示在線，0表示離線, 2表示待注冊 |
| StreamStatus | String | 1 |
流狀態，1流在線，0流離線 |
| StreamAction | String | 1 |
啟流狀態， 1 啟動拉流，0 停止拉流 |
| ParentDeviceId | String | 33011012011327999**** |
如果此屬性不為空，代表此IPC是屬于NVRDeviceID的下掛通道。 如果為空，代表此IPC是獨立接入的 |
| CreateTime | String | 2021-08-26T12:31:22 |
設備創建時間 |
| ModifyTime | String | 2021-08-26T12:31:22 |
設備修改時間 |
| Vap | String | 略 |
內部字段，忽略 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeIpcs
&PageNum=1
&PageSize=10
&ParentDeviceType=NVR
&DeviceIdList=100001****,100002****,100003****
&NvrIdList=100001****,100002****,100003****
&CorpIdList=100001****,100002****,100003****
&DeviceFilter=100001****
&公共請求參數正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeIpcsResponse>
<RequestId>46329898-489C-4E63-9BA1-C1DA5C5D0986</RequestId>
<Code>200</Code>
<Message>Success</Message>
<Data>
<TotalCount>32</TotalCount>
<TotalPage>4</TotalPage>
<PageNum>1</PageNum>
<PageSize>10</PageSize>
<Records>
<Record>
<CorpId>100001****</CorpId>
<ServerId>330100990120****</ServerId>
<ServerIp>192.168.XX.XX</ServerIp>
<ServerRealm>2021****</ServerRealm>
<ServerPort>5060</ServerPort>
<DeviceId>33011012011327999****</DeviceId>
<Password>******</Password>
<DeviceName>example</DeviceName>
<DeviceAddress>某地市</DeviceAddress>
<Longitude>116.397128</Longitude>
<Latitude>39.916527</Latitude>
<DeviceDirection>由內朝外</DeviceDirection>
<DeviceSite>大門門口</DeviceSite>
<DeviceResolution>1920*1080</DeviceResolution>
<DeviceRate>2048</DeviceRate>
<FrameRate>25</FrameRate>
<GovLength>50</GovLength>
<EncodeFormat>6</EncodeFormat>
<AudioEnable>1</AudioEnable>
<OSDTimeEnable>1</OSDTimeEnable>
<OSDTimeType>1</OSDTimeType>
<OSDTimeX>99</OSDTimeX>
<OSDTimeY>1</OSDTimeY>
<Vendor>阿里云</Vendor>
<DeviceType>IPC</DeviceType>
<DeviceModel>ACube200-8</DeviceModel>
<InProtocol>GBT28181</InProtocol>
<DeviceSn>ca0e71642974****</DeviceSn>
<DatasourceType>VIDEO</DatasourceType>
<DeviceSubType>1</DeviceSubType>
<DeviceIp>192.168.XX.XX</DeviceIp>
<DeviceStatus>1</DeviceStatus>
<StreamStatus>1</StreamStatus>
<StreamAction>1</StreamAction>
<ParentDeviceId>33011012011327999****</ParentDeviceId>
<CreateTime>2021-08-26T12:31:22</CreateTime>
<ModifyTime>2021-08-26T12:31:22</ModifyTime>
<Vap>略</Vap>
</Record>
</Records>
</Data>
</DescribeIpcsResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "46329898-489C-4E63-9BA1-C1DA5C5D0986",
"Code" : "200",
"Message" : "Success",
"Data" : {
"TotalCount" : 32,
"TotalPage" : 4,
"PageNum" : 1,
"PageSize" : 10,
"Records" : [ {
"CorpId" : "100001****",
"ServerId" : "330100990120****",
"ServerIp" : "192.168.XX.XX",
"ServerRealm" : "2021****",
"ServerPort" : "5060",
"DeviceId" : "33011012011327999****",
"Password" : "******",
"DeviceName" : "example",
"DeviceAddress" : "某地市",
"Longitude" : "116.397128",
"Latitude" : "39.916527",
"DeviceDirection" : "由內朝外",
"DeviceSite" : "大門門口",
"DeviceResolution" : "1920*1080",
"DeviceRate" : "2048",
"FrameRate" : "25",
"GovLength" : "50",
"EncodeFormat" : "6",
"AudioEnable" : "1",
"OSDTimeEnable" : "1",
"OSDTimeType" : "1",
"OSDTimeX" : "99",
"OSDTimeY" : "1",
"Vendor" : "阿里云",
"DeviceType" : "IPC",
"DeviceModel" : "ACube200-8",
"InProtocol" : "GBT28181",
"DeviceSn" : "ca0e71642974****",
"DatasourceType" : "VIDEO",
"DeviceSubType" : "1",
"DeviceIp" : "192.168.XX.XX",
"DeviceStatus" : "1",
"StreamStatus" : "1",
"StreamAction" : "1",
"ParentDeviceId" : "33011012011327999****",
"CreateTime" : "2021-08-26T12:31:22",
"ModifyTime" : "2021-08-26T12:31:22",
"Vap" : "略"
} ]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。