更新时间:2025-11-19 GMT+08:00
分享

获取视频源分组详情

功能介绍

获取视频源分组详情。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

video_group_id

String

视频源分组id,只能由小写英文字母(a~z)、数字(0~9)、中划线(-)、下划线(_)组成长度范围是[4,36]。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

video_group_id

String

视频源所在分组id。

video_group_name

String

视频源所在分组名称。

description

String

视频源所在分组描述。

access_type

String

接入类型。

  • cloud:云上。

  • edge: 边缘。

create_at

Long

创建时间。

modify_at

Long

修改时间。

num_video_source

Integer

视频源数量。

group_status

GroupStatusDto object

视频源状态。

num_batch_task

Integer

已配置批量作业数量。

表4 GroupStatusDto

参数

参数类型

描述

num_online

Integer

在线视频源数量。

num_exception

Integer

异常视频源数量。

num_offline

Integer

离线视频源数量。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

detail

String

错误详情。

params

Array of strings

错误参数列举。

reason

String

错误原因。

advice

String

建议。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

detail

String

错误详情。

params

Array of strings

错误参数列举。

reason

String

错误原因。

advice

String

建议。

请求示例

获取视频源分组详情,展示分组名称,接入方式,分组下面的视频源列表等分组信息

/v2/{project_id}/video-group/{video_group_id}

https://{endpoint}/v2/{project_id}/video-group/{video_group_id}

响应示例

状态码:200

视频源分组信息。

{
  "video_group_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx",
  "video_group_name" : "test000",
  "description" : "",
  "access_type" : "cloud",
  "create_at" : 1680773327730,
  "modify_at" : 1680773463291,
  "num_video_source" : 2,
  "group_status" : {
    "num_online" : 2,
    "num_exception" : 0,
    "num_offline" : 0
  },
  "num_batch_task" : 0
}

状态码

状态码

描述

200

视频源分组信息。

400

请求错误。

500

内部错误。

相关文档