获取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表示待注册 |
返回数据
示例
请求示例
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" : "略"
} ]
}
}错误码
访问错误中心查看更多错误码。
