Updated on 2024-04-22 GMT+08:00

Updating a Video Source Group

Function

This API is used to modify a video source group.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

video_group_id

Yes

String

ID of a created video source group. The value is a string of 4 to 36 characters consisting of only lowercase letters, digits, hyphens (-), and underscores (_).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. For details about how to obtain a user token, see Authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

video_group_name

No

String

Name of a video source group. If this parameter is not input, the name is not changed. The name is a string of 1 to 20 characters consisting of hyphens (-), underscores (_), letters, and digits.

Minimum: 1

Maximum: 20

description

No

String

Description. If this parameter is not input, the description is not modified.

Maximum: 100

video_source_ids

Yes

Array of strings

IDs of video sources in a group. The number of IDs must range from 1 to 50. Each ID can contain only lowercase letters, digits, hyphens (-), and underscores (_). The length range is [4, 36].

Array Length: 1 - 50

Response Parameters

None

Example Requests

Request body for modifying a video source group

/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" : ""
}

Example Responses

None

Status Codes

Status Code

Description

200

Operation successful

Error Codes

See Error Codes.