查询AI应用列表
最近更新时间:2026-03-19 18:16:28
天翼云智能视图服务API
1.查询AI应用列表
接口功能介绍
本接口用于查询AI应用列表。
接口约束
无
URI
GET /ai/apps
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| AiAbilityId | 否 | Integer | 算法分类ID,可通过查询AI算法分类API获取。 | 1 | |
| AlgorithmId | 否 | Integer | 根据算法类型ID检索,可通过查询AI算法列表API获取。 | 2 | |
| Keyword | 否 | String | 根据应用名称或描述模糊检索。 | 吸烟检测 | |
| PageNum | 否 | Integer | 第几个分页,默认为1。 | 1 | |
| PageSize | 否 | Integer | 分页大小,默认为20。取值范围为1~1000。 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 认证信息。 | CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f | |
| Content-Type | 是 | String | 互联网媒体类型。 | application/json;charset=utf-8 | |
| Host | 是 | String | 主机。 | vssapi.ctyun.cn | |
| Version | 是 | String | 版本。 | 2021-11-25 | |
| Timestamp | 是 | String | 时间戳。 | 1689643309 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | c175cb57c1704bc7b12363931bd8b4e6 | |
| returnObj | Object | 响应数据。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| PageNum | Integer | 第几个分页。 | 1 | |
| PageSize | Integer | 分页大小。 | 20 | |
| TotalPage | Integer | 分页总数。 | 2 | |
| TotalNum | Integer | 应用总数。 | 30 | |
| AiApps | Array of Objects | 应用列表。 | AiApps | |
| RequestId | String | 请求ID。 | c175cb57c1704bc7b12363931bd8b4e6 |
表 AiApps
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| AppId | String | 应用ID。 | 583 | |
| AppName | String | 应用名称。 | 1113 | |
| Description | String | 应用描述。 | ||
| AnalyseType | String | 分析类别,分钟级AI-100;秒级AI-200。 | AI-100 | |
| OperTimeSlot | Array of Objects | AI应用生效时间段,最多包含五组时间段。默认为全天(00:00:00-23:59:59)。 | OperTimeSlot | |
| Confidence | String | 置信度。 | 0.8 | |
| Algorithm | Object | 算法详情。 | Algorithm | |
| AssociateDevices | Integer | 关联设备数。 | 0 | |
| CreateTime | String | 创建时间。 | 2023-10-18 15:09:32 | |
| UpdateTime | String | 更新时间。 | 2023-10-18 15:28:37 |
表 Algorithm
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| AlgorithmsId | String | AI算法类型ID。 | 2 | |
| Name | String | 算法名称。 | 吸烟检测 | |
| Summary | String | 算法概要。 | 检测图像中的所有人体,返回每个人体的位置坐标。识别人体的20余类属性信息,包含性别年龄、服饰类别、服饰颜色等。 | |
| AiAbilityId | String | 算法分类ID。 | 1 |
表 OperTimeSlot
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| StartTime | String | 开始时间。格式为"hh:mm:ss",且StartTime必须小于EndTime。 | 08:40:00 | |
| EndTime | String | 结束时间。格式为"hh:mm:ss",且StartTime必须小于EndTime。 | 09:40:00 |
请求示例
请求url
GET '/ai/apps'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=1R9M5WFHWV25TQPD54XL/2023-11-03/vss, SignedHeaders=content-type;host;timestamp, Signature=bb12968aaabd8d65b93ed66f1663a99e2f4d33eb35c31e68feead0e6ff84ee4a",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1699001769"
}
请求体body
无
响应示例
{
"statusCode": 200,
"message": "请求成功",
"requestId": "d0de0b3029ee42158cb6dbe46bf26ebe",
"returnObj": {
"AiApps": [
{
"AppId": "636",
"AppName": "test7792",
"Description": "",
"AnalyseType": "AI-100",
"OperTimeSlot": [
{
"StartTime": "00:00:00",
"EndTime": "23:59:59"
}
],
"Confidence": 0.6,
"Algorithm": {
"AlgorithmsId": "2",
"Name": "吸烟检测",
"Summary": "检测图像中的所有人体,返回每个人体的位置坐标。识别人体的20余类属性信息,包含性别年龄、服饰类别、服饰颜色等。",
"AiAbilityId": "2"
},
"AssociateDevices": "0",
"AlertConfig": {
"AlertPeriod": "0",
"AlertTriggerThreshold": "0",
"AlertSilencePeriod": "0"
},
"CreateTime": "2023-12-06 15:28:00",
"UpdateTime": "2023-12-06 15:28:00"
},
],
"PageNum": 1,
"PageSize": 20,
"TotalPage": 1,
"TotalNum": 1,
"RequestId": "d0de0b3029ee42158cb6dbe46bf26ebe"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录: