文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 视频中心/ 获取视频源分组列表 - ListVideoGroups
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取视频源分组列表 - ListVideoGroups

功能介绍

获取视频源分组列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/video-group/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID，获取方法参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32]。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

sort_name

否

String

参数解释：

排序项。

约束限制：

不涉及。

取值范围：

  • create_at

  • modify_at

  • num_video_source

  • num_task

默认取值：

create_at

order_by

否

String

参数解释：

排序顺序。

约束限制：

不涉及。

取值范围：

  • desc（倒序）

  • asc（正序）

默认取值：

desc

is_paged

否

Boolean

参数解释：

是否分页。

约束限制：

不涉及。

取值范围：

  • true：开启分页

  • false：关闭分页

默认取值：

false

page_size

否

Integer

参数解释：

分页每页显示的条目。

约束限制：

不涉及。

取值范围：

5-200

默认取值：

10

page_num

否

Integer

参数解释：

第几页。

约束限制：

不涉及。

取值范围：

1-100000

默认取值：

1

name

否

String

参数解释：

模糊查找参数，可以按分组名称进行模糊查找。

约束限制：

不涉及。

取值范围：

字符串长度[0, 20]。

默认取值：

不涉及。

status

否

String

参数解释：

状态。

约束限制：

不涉及。

取值范围：

  • 1（在线）

  • 2（离线）

  • 9（异常）

默认取值：

不涉及。

access_type

否

Array of strings

参数解释：

接入方式。

约束限制：

不涉及。

取值范围：

接入方式枚举值：

  • cloud（云上）

  • edge（边缘）

默认取值：

不涉及。

has_task

否

Boolean

参数解释：

是否有批量作业。

约束限制：

不涉及。

取值范围：

  • true：有批量作业

  • false：没有批量作业

默认取值：

false

type

否

Array of strings

参数解释：

视频源类型。

约束限制：

不涉及。

取值范围：

  • obs

  • vcn

  • url

  • restful

  • camera

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，获取方法参见认证鉴权。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

video_group_number

Integer

参数解释：

分组数量。

取值范围：

不涉及。

total_number

Integer

参数解释：

视频源分组总数。

取值范围：

不涉及。

quota_number

Integer

参数解释：

视频源分组最大限额。

取值范围：

不涉及。

video_group_list

Array of VideoGroupListInfoDto objects

参数解释：

分组列表。

取值范围：

不涉及。
表5 VideoGroupListInfoDto

参数

参数类型

描述

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

参数解释：

分组中视频源类型。

取值范围：

不涉及。
表6 GroupStatusDto

参数

参数类型

描述

num_online

Integer

参数解释：

在线视频源数量。

取值范围：

不涉及。

num_exception

Integer

参数解释：

异常视频源数量。

取值范围：

不涉及。

num_offline

Integer

参数解释：

离线视频源数量。

取值范围：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

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

视频源分组列表响应体。

400

请求错误。

500

内部错误。
父主题： 视频中心

相关文档