获取视频源分组列表
功能介绍
获取视频源分组列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/video-group/groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户项目ID，获取方法参见获取项目ID和名称。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
sort_name |
否 |
String |
排序项。可选，可选值（create_at、modify_at、num_video_source、num_task）。 |
|
order_by |
否 |
String |
排序顺序，可选，默认倒序，可选值（desc、asc）。 |
|
is_paged |
否 |
Boolean |
是否分页。 |
|
page_size |
否 |
Integer |
分页每页显示的条目。 |
|
page_num |
否 |
Integer |
第几页。 |
|
name |
否 |
String |
模糊查找参数，可以按分组名称进行模糊查找。 |
|
status |
否 |
String |
状态level筛选，可选值（1、2、9）。 |
|
access_type |
否 |
Array of strings |
根据接入方式筛选（可多选），可选值（cloud、edge）。 |
|
has_task |
否 |
Boolean |
是否有批量作业。 |
|
type |
否 |
Array of strings |
视频源类型筛选（可多选）类型:obs、vcn、url、restful、camera。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，获取方法参见认证鉴权。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
video_group_number |
Integer |
分组数量 |
|
total_number |
Integer |
视频源分组总数 |
|
quota_number |
Integer |
视频源分组最大限额 |
|
video_group_list |
Array of VideoGroupListInfoDto objects |
分组列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
video_group_id |
String |
视频源分组id |
|
video_group_name |
String |
视频源分组名称 |
|
num_video_source |
Integer |
视频源数量 |
|
group_status |
GroupStatusDto object |
分组中视频源状态 |
|
access_type |
String |
接入方式 |
|
create_at |
Long |
创建时间 |
|
modify_at |
Long |
最后一次修改时间 |
|
num_batch_task |
Integer |
已配置批量作业数量 |
|
type |
String |
分组中视频源类型 |
请求示例
获取视频源分组列表，展示出账户下的所有视频源分组信息：
/v2/{project_id}/videoGroup/groups?is_paged=true&page_size=10&page_num=1
https://{endpoint}/v2/{project_id}/videoGroup/groups?is_paged=true&page_size=10&page_num=1
响应示例
状态码： 200
视频源分组列表响应体
{
"video_group_number": 23,
"total_number": 23,
"quota_number": 200,
"video_group_list": [
{
"video_group_id": "a9334780-a53c-454e-a3c1-259c54678ec1",
"video_group_name": "test000",
"num_video_source": 2,
"group_status": {
"num_online": 2,
"num_exception": 0,
"num_offline": 0
},
"access_type": "cloud",
"create_at": 1680773327730,
"modify_at": 1680773463291,
"num_batch_task": 0,
"type": "restful"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
视频源分组列表响应体 |
