功能介绍
1.1.6 IPC 管理
1.1.6.1 查询 IPC 列表 功能介绍功能介绍
状态码
状态码 描述
204 No Content 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
405 Method Not Allowed 409 Conflict
429 Too Many Requests 500 Internal Server Error
错误码
请参见错误码。
1.1.6 IPC 管理
1.1.6.1 查询 IPC 列表 功能介绍
获取多个IPC资源
URI
GET /v1/{project_id}/cameras
表1-41 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 参数说明：项目ID。获取方法请 参见 获取项目ID。
取值范围：仅支持数字，a到f的 小写字母组合，长度32。
正则匹配：^[0-9a-f]{32}$
表1-42 Query 参数
参数 是否必选 参数类型 描述
offset 否 Integer 参数说明：查询摄像机列表的页
码。
最小值：1 最大值：100 缺省值：0
limit 否 Integer 参数说明：查询摄像机时每页显
示的记录数。
最小值：1 最大值：20 缺省值：10
status 否 String 参数说明：摄像机的状态。
取值范围：
● ONLINE：在线
● OFFLINE：离线
● INITIAL：初始化
● UNKNOWN：未知
● SLEEP：休眠 枚举值：
● ONLINE
● OFFLINE
● INITIAL
● UNKNOWN
● SLEEP
v2x_edge_id 否 String 参数说明：Edge ID，用于唯一 标识一个Edge，创建Edge后获 得。方法参见 创建Edge。
最小长度：0 最大长度：255
请求参数
表1-43 请求 Header 参数
参数 是否必选 参数类型 描述
Instance-Id 否 String 参数说明：实例ID。dris物理实 例的唯一标识。获取方法参见获
取Instance-Id。
取值范围：仅支持数字，小写字 母和横杠（-）的组合，长度 36。
正则匹配：^[a-z0-9-]{36}$
X-Auth-Token 否 String 参数说明：用户Token，Token 认证鉴权时必选。通过调用IAM 服务 获取IAM用户Token接口 获取，接口返回的响应消息头中
“X-Subject-Token”就是需要 获取的用户Token。简要的获取 方法样例请参见 Token认证。
最小长度：1 最大长度：20000
响应参数
状态码： 200
表1-44 响应 Body 参数
参数 参数类型 描述
count Long 参数说明：总数
最小值：0 最大值：2000 ipcs Array of
IpcResponse DTO objects
参数说明：IPC列表
表1-45 IpcResponseDTO
参数 参数类型 描述
camera_id String 参数说明：摄像头ID，console界面查询摄像头 IPC列表中的设备Id。
最小长度：0 最大长度：255
v2x_edge_id String 参数说明：Edge ID，用于唯一标识一个Edge，
创建Edge后获得。方法参见 创建Edge。
最小长度：0 最大长度：128
正则匹配：(^$|^[a-zA-Z0-9_-]{1,128}$) name String 参数说明：摄像头名称。
最小长度：0 最大长度：255
cross_id String 参数说明：摄像头所感知的路口或者路段的Id。
最小长度：0 最大长度：255
focal_type String 参数说明：摄像头聚焦类型。
● long：长焦
● short：短焦 parent_conne
ct_code String 参数说明：摄像头连接的ITS800的互联编码。
最小长度：0 最大长度：128
connect_code String 参数说明：摄像头的互联编码。
最小长度：0 最大长度：128 description String 参数说明：描述。
最大长度：255
正则匹配：(^$|^[\u4e00-\u9fa5a-zA-Z0-9_-]
{1,256}$)
esn String 参数说明：IPC的设备编码。
最大长度：64
正则匹配：^[a-zA-Z0-9_]{1,64}$
参数 参数类型 描述
status String 参数说明：摄像机的状态。
取值范围：
● ONLINE：在线
● OFFLINE：离线
● INITIAL：初始化
● UNKNOWN：未知
● SLEEP：休眠 枚举值：
● ONLINE
● OFFLINE
● INITIAL
● UNKNOWN
● SLEEP
created_time String 参数说明：创建时间。
格式：yyyy-MM-dd''T''HH:mm:ss''Z''。
例如 2020-09-01T01:37:01Z。
last_modified
_time String 参数说明：最后修改时间。
格式：yyyy-MM-dd''T''HH:mm:ss''Z''。
例如 2020-09-01T01:37:01Z。
last_online_ti
me String 参数说明：最后在线时间。
格式：yyyy-MM-dd''T''HH:mm:ss''Z''。
例如 2020-09-01T01:37:01Z。
请求示例
GET https://{endpoint}/v1/{project_id}/cameras?
limit={limit}&status={status}&v2x_edge_id={v2x_edge_id}&offset={offset}
Content-Type:application/json X-Auth-Token:********
Instance-Id:********
响应示例
状态码： 200 OK
{
"parent_connect_code" : "connectcode", "connect_code" : "code",
"description" : "test", "esn" : "124546416113", "status" : "ONLINE",
"created_time" : "2021-12-23T12:59:43.935Z", "last_modified_time" : "2021-12-23T12:59:43.935Z", "last_online_time" : "2021-12-23T12:59:43.935Z"
} ] }
状态码
状态码 描述
200 OK
400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
405 Method Not Allowed 409 Conflict
429 Too Many Requests 500 Internal Server Error
错误码
请参见错误码。