获取视频源分组详情 - ShowVideoGroupDetail
功能介绍
获取视频源分组详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/video-group/{video_group_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 用户项目ID,获取方法参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
video_group_id |
是 |
String |
参数解释: 视频源分组id。 约束限制: 不涉及。 取值范围: 只能由小写英文字母(a~z)、数字(0~9)、中划线(-)、下划线(_)组成。长度范围是[4,36]。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,获取方法参见认证鉴权。 约束限制: 不涉及。 取值范围: 字符串长度[0, 32768]。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
video_group_id |
String |
参数解释: 视频源所在分组id。 取值范围: 不涉及。 |
|
video_group_name |
String |
参数解释: 视频源所在分组名称。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 视频源所在分组描述。 取值范围: 不涉及。 |
|
access_type |
String |
参数解释: 接入类型。
取值范围: 不涉及。 |
|
create_at |
Long |
参数解释: 创建时间。 取值范围: 不涉及。 |
|
modify_at |
Long |
参数解释: 修改时间。 取值范围: 不涉及。 |
|
num_video_source |
Integer |
参数解释: 视频源数量。 取值范围: 不涉及。 |
|
group_status |
GroupStatusDto object |
参数解释: 视频源状态。 取值范围: 不涉及。 |
|
num_batch_task |
Integer |
参数解释: 已配置批量作业数量。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
num_online |
Integer |
参数解释: 在线视频源数量。 取值范围: 不涉及。 |
|
num_exception |
Integer |
参数解释: 异常视频源数量。 取值范围: 不涉及。 |
|
num_offline |
Integer |
参数解释: 离线视频源数量。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息描述。 取值范围: 不涉及。 |
|
detail |
String |
参数解释: 错误详情。 取值范围: 不涉及。 |
|
params |
Array of strings |
参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
|
reason |
String |
参数解释: 错误原因。 取值范围: 不涉及。 |
|
advice |
String |
参数解释: 建议。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息描述。 取值范围: 不涉及。 |
|
detail |
String |
参数解释: 错误详情。 取值范围: 不涉及。 |
|
params |
Array of strings |
参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
|
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 |
内部错误。 |