Obtaining Details About a Video Source Group
Function
This API is used to obtain details about a video source group.
URI
GET /v2/{project_id}/video-group/{video_group_id}
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 video source group. The value is a string of 4 to 36 characters consisting of only lowercase letters, digits, hyphens (-), and underscores (_). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. For details about how to obtain a user token, see Authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
video_group_id |
String |
ID of the group to which the video source belongs |
video_group_name |
String |
Name of the group to which the video source belongs |
description |
String |
Description of the group to which the video source belongs |
access_type |
String |
Access type, which can be cloud or edge. |
create_at |
Long |
Creation time |
modify_at |
Long |
Modification time |
num_video_source |
Integer |
Number of video resources |
group_status |
GroupStatusDto object |
Video source status |
num_batch_task |
Integer |
Number of configured batch tasks |
Example Requests
This request is used to obtain video source group details, including the group name, access type, and video sources in the group.
/v2/{project_id}/video-group/{video_group_id} https://{endpoint}/v2/{project_id}/video-group/{video_group_id}
Example Responses
Status code: 200
Video source group information
{ "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 }
Status Codes
Status Code |
Description |
---|---|
200 |
Video source group information |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot