更新视频源分组 - UpdateVideoGroup
功能介绍
更新视频源分组。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /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]。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
video_group_name |
否 |
String |
参数解释: 视频源分组名称。如不传入则不修改名称。 约束限制: 不涉及。 取值范围: 只能由中文、中划线(-)、下划线(_)、英文字母(a~z)、数字(0~9)组成。长度范围为[1, 20]。 默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 描述。如不传入则不修改描述。 约束限制: 不涉及。 取值范围: 字符串长度[0, 100]。 默认取值: 不涉及。 |
|
video_source_ids |
是 |
Array of strings |
参数解释: 分组中的视频源id集。 约束限制: 不涉及。 取值范围: id个数需在1~50,每个id只能由小写英文字母(a~z,)、数字(0~9)、中划线(-)、下划线(_)组成。长度范围为[4, 36]。 默认取值: 不涉及。 |
响应参数
状态码:200
更新成功。
状态码: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}
{
"video_source_ids" : [ "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx", "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx" ],
"video_group_name" : "test000",
"description" : ""
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新成功。 |
|
400 |
请求错误。 |
|
500 |
内部错误。 |