# 获取视频源列表 - ListVideoSources
#### 功能介绍
获取视频源列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VIAS/doc?api=ListVideoSources)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### URI
GET /v2/{project_id}/source/sources
表1路径参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|:---|:---|:---|:---|
| project_id | 是 | String | **参数解释：** 用户项目ID，获取方法参见[获取项目ID和名称](https://support.huaweicloud.com/api-vias/vias_03_0283.html)。 **约束限制：** 不涉及。 **取值范围：** 字符串长度\[0, 32\]。 **默认取值：** 不涉及。 |
表2Query参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|:---|:---|:---|:---|
| scope | 否 | String | **参数解释：** 模糊查找参数，根据名称查找。 **约束限制：** 不涉及。 **取值范围：** 字符串长度\[0, 255\]。 **默认取值：** 不涉及。 |
| scope_name | 否 | String | **参数解释：** 模糊查找参数字段名。 **约束限制：** 不涉及。 **取值范围：** - source_name（名称） - group_name（分组名称） **默认取值：** source_name |
| status | 否 | Array of strings | **参数解释：** 视频源状态。 **约束限制：** 不涉及。 **取值范围：** 列表长度\[0, 3\]。 视频源状态枚举值： - 1（在线） - 2（离线） - 9（异常） **默认取值：** 不涉及。 |
| type | 否 | Array of strings | **参数解释：** 视频源类型。 **约束限制：** 不涉及。 **取值范围：** 列表长度\[0, 10\]。 视频源类型枚举值： - ivm - restful - url - vcn - obs - camera - vcn_restful **默认取值：** 不涉及。 |
| video_group_id | 否 | Array of strings | **参数解释：** 视频源分组。 **约束限制：** 不涉及。 **取值范围：** 列表元素需要符合正则表达式\^\[0-9a-zA-Z-_\]{1,36}$。 **默认取值：** 不涉及。 |
| sort_name | 否 | String | **参数解释：** 排序项。 **约束限制：** 不涉及。 **取值范围：** - create_at - num_task - num_template **默认取值：** create_at |
| order_by | 否 | String | **参数解释：** 排序顺序。 **约束限制：** 不涉及。 **取值范围：** - desc（倒序） - asc（正序） **默认取值：** desc |
| is_paged | 否 | Boolean | **参数解释：** 是否分页。 **约束限制：** 不涉及。 **取值范围：** - true：开启分页 - false：关闭分页 **默认取值：** false |
| page_size | 否 | Integer | **参数解释：** 分页每页显示的条目。 **约束限制：** 不涉及。 **取值范围：** 5-200 **默认取值：** 10 |
| page_num | 否 | Integer | **参数解释：** 第几页。 **约束限制：** 不涉及。 **取值范围：** 1-100000 **默认取值：** 1 |
| access_type | 否 | Array of strings | **参数解释：** 接入方式。 **约束限制：** 不涉及。 **取值范围：** 列表长度\[0, 2\]。 接入方式枚举值： - cloud（云上） - edge（边缘） **默认取值：** 不涉及。 |
| platform_name | 否 | String | **参数解释：** 平台名称。 **约束限制：** 不涉及。 **取值范围：** 字符串长度\[0, 100\]。 **默认取值：** 不涉及。 |
| tag | 否 | String | **参数解释：** 标签。 **约束限制：** 不涉及。 **取值范围：** 字符串长度\[0, 255\]。 **默认取值：** 不涉及。 |
#### 请求参数
表3请求Header参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|:---|:---|:---|:---|
| X-Auth-Token | 是 | String | **参数解释：** 用户Token，获取方法参见[认证鉴权](https://support.huaweicloud.com/api-vias/vias_03_0009.html)。 **约束限制：** 不涉及。 **取值范围：** 字符串长度\[0, 32768\]。 **默认取值：** 不涉及。 |
#### 响应参数
**状态码：200**
表4响应Body参数
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| video_source_number | Integer | **参数解释：** 视频源数量。 **取值范围：** 不涉及。 |
| total_number | Integer | **参数解释：** 视频源总数。 **取值范围：** 不涉及。 |
| quota_number | Integer | **参数解释：** 视频源限额。 **取值范围：** 不涉及。 |
| video_source_list | Array of [ListVideoSourceInfoDto] objects | **参数解释：** 视频源列表数据。 **取值范围：** 不涉及。 |
表5ListVideoSourceInfoDto
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| video_source_id | String | **参数解释：** 已创建成功的视频源id。 **取值范围：** 不涉及。 |
| video_source_name | String | **参数解释：** 视频源名称。 **取值范围：** 只支持中文、英文字母（a-z,A-Z）、数字、特殊字符（空格.-_() （）），不能以空格开头和结尾 最小长度：1 最大长度：100 |
| status | [VideoSourceStatusInfoDto] object | **参数解释：** 视频源状态。 **取值范围：** 不涉及。 |
| access_type | String | **参数解释：** 接入类型。 **取值范围：** \['cloud（云上）', 'edge（边缘）'\] |
| type | String | **参数解释：** 类型。 **取值范围：** \['obs', 'vcn', 'url', 'restful', 'camera'\] |
| latitude | String | **参数解释：** 视频源的地理位置信息，纬度，-90.00000\~90.00000。 **取值范围：** 不涉及。 |
| longitude | String | **参数解释：** 视频源的地理位置信息，经度，-180.00000\~180.00000。 **取值范围：** 不涉及。 |
| create_at | Long | **参数解释：** 创建时间。 **取值范围：** 不涉及。 |
| video_packages | Array of [VideoGroupInfoDto] objects | **参数解释：** 视频源所在分组。 **取值范围：** 不涉及。 |
| num_tasks | Integer | **参数解释：** 视频源已运行算法作业数量。 **取值范围：** 不涉及。 |
| num_service_config_templates | Integer | **参数解释：** 视频源算法服务配置模板数量。 **取值范围：** 不涉及。 |
| type_config | String | **参数解释：** 视频源配置信息xml。 **取值范围：** 长度范围\[1，1024\]。 url形式： ``` ``` vcn形式： ``` ``` restful形式： ``` ``` ivm形式： ``` ``` obs形式： ``` ``` camera形式： ``` ``` vcn_restful形式： ``` restful ``` |
| tag | Array of strings | **参数解释：** 视频源标签。 **取值范围：** 标签最多选择4个，标签内容只能由中文， 英文字母(a\~z, A\~Z)、数字(0\~9)、中划线(-)、下划线(_)组成。长度范围为\[1, 10\]。 |
| stream_path | String | **参数解释：** 流地址。 **取值范围：** 不涉及。 |
| scene_recommend | Array of strings | **参数解释：** 智能算法推荐的标签。 **取值范围：** 不涉及。 |
| video_source_quality | Array of strings | **参数解释：** 视频源的视频流质量： - Blurry：画面模糊。 - ColorDistortion：画面颜色失真。 - AbnormalLight：画面光线异常。 - ScreenSplash：画面花屏异常。 - ScreenJitter：画面抖动。 - ScreenMovement：画面移动。 - SceneUpheaval：画面剧变。 - ScreenFreeze：画面冻结。 - BlackScreen：黑屏。 - SnowNoise：雪花噪声。 - Occlude：遮挡。 - GrayScreen：灰屏。 - ScreenSmudge：画面污迹。 **取值范围：** 不涉及。 |
表6VideoSourceStatusInfoDto
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| status | String | **参数解释：** 视频源状态： - Online：在线。 - Offline：离线。 - exception：异常。 **取值范围：** 不涉及。 |
| name | String | **参数解释：** 状态中文名。 **取值范围：** 不涉及。 |
| level | String | **参数解释：** 状态等级（用于前端图片颜色匹配）。 **取值范围：** 不涉及。 |
表7VideoGroupInfoDto
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| 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 | **参数解释：** 已配置批量作业数量。 **取值范围：** 不涉及。 |
表8GroupStatusDto
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| num_online | Integer | **参数解释：** 在线视频源数量。 **取值范围：** 不涉及。 |
| num_exception | Integer | **参数解释：** 异常视频源数量。 **取值范围：** 不涉及。 |
| num_offline | Integer | **参数解释：** 离线视频源数量。 **取值范围：** 不涉及。 |
**状态码：400**
表9响应Body参数
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 |
| error_msg | String | **参数解释：** 错误信息描述。 **取值范围：** 不涉及。 |
| detail | String | **参数解释：** 错误详情。 **取值范围：** 不涉及。 |
| params | Array of strings | **参数解释：** 错误参数列举。 **取值范围：** 列表长度\[0, 1\]。 |
| reason | String | **参数解释：** 错误原因。 **取值范围：** 不涉及。 |
| advice | String | **参数解释：** 建议。 **取值范围：** 不涉及。 |
**状态码：500**
表10响应Body参数
| 参数 | 参数类型 | 描述 |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 |
| error_msg | String | **参数解释：** 错误信息描述。 **取值范围：** 不涉及。 |
| detail | String | **参数解释：** 错误详情。 **取值范围：** 不涉及。 |
| params | Array of strings | **参数解释：** 错误参数列举。 **取值范围：** 列表长度\[0, 1\]。 |
| reason | String | **参数解释：** 错误原因。 **取值范围：** 不涉及。 |
| advice | String | **参数解释：** 建议。 **取值范围：** 不涉及。 |
#### 请求示例
获取视频源列表，展示出账户下的所有视频源信息。
```
v2/{project_id}/source/sources
https://{endpoint}/v2/{project_id}/source/sources?is_paged=true&page_size=10&page_num=1&scope_name=source_name
```
#### 响应示例
**状态码：200**
视频源列表响应体。
```
{
"video_source_number" : 230,
"total_number" : 230,
"quota_number" : 5000,
"video_source_list" : [ {
"video_source_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx",
"video_source_name" : "url_test",
"status" : {
"status" : "Online",
"name" : "在线",
"level" : "1"
},
"access_type" : "cloud",
"type" : "url",
"latitude" : "",
"longitude" : "",
"create_at" : 1680772763191,
"video_packages" : [ ],
"num_tasks" : 0,
"num_service_config_templates" : 0,
"type_config" : "rtsp://12.12.12.12:333",
"tag" : [ ],
"stream_path" : "rtsp://12.12.12.12:333",
"device_id" : "1680772763191",
"scene_recommend" : [ ],
"video_source_quality" : [ ]
} ]
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | 视频源列表响应体。 |
| 400 | 参数错误。 |
| 500 | 内部错误。 |