文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 算法中心/ 我的算法服务列表
更新时间：2024-09-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

我的算法服务列表

功能介绍

我的算法服务列表

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/algorithm/services/user

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID，获取方法参见获取项目ID和名称
表2 Query参数

参数

是否必选

参数类型

描述

name_like

否

String

服务名称，支持模糊匹配

is_paged

否

Boolean

是否分页

page_size

否

Integer

每页的最大条目数

page_num

否

Integer

第几页

order_by

否

String

排序方式，可选“asc”或“desc”，代表递增排序及递减排序

sort_name

否

String

排序字段，可选“created_at”或“function_version”

alg_status

否

Array of strings

服务状态，支持多选。可选“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”、“not_deployed”

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，获取方法参见认证鉴权

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

数量

service_list

Array of ServicesListInfoDto objects

服务列表

total

Integer

总数数量
表5 ServicesListInfoDto

参数

参数类型

描述

alg_id

String

算法ID

service_id

String

服务ID

service_name

String

服务名称

package_id

String

算法服务包ID

package_name

String

算法服务包名称

company

String

厂商名称

alg_version

String

算法版本

function_version

String

功能版本

tags

Array of strings

应用场景标签

created_at

Long

创建时间

alg_status

String

算法状态，取值为“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”或者“not_deployed”

deploy_type

String

部署类型，取值为“cloud”或者“edge”

alg_class

String

算法类别，取值为“self”或者“partner”

request_mode

String

请求模式，取值为“sync”或者“async”

description

String

算法描述，信息非空时返回

error_msg

String

服务异常信息，信息非空时返回

can_update

Boolean

是否可升级，值为true时返回

new_alg_id

String

升级后的算法ID，可升级时返回

请求示例

我的算法服务列表，过滤出状态为“运行中”、“已停止”或“部署异常”的服务

GET https://{endpoint}/v2/{project_id}/algorithm/services/user?alg_status=service_running&alg_status=service_stopped&alg_status=service_failed

响应示例

状态码： 200

我的算法服务列表响应体

{
  "count" : 3,
  "service_list" : [ {
    "alg_id" : "068ed4d8-077e-4ec9-aa19-bc******e925",
    "service_id" : "331bcb4a-5b3c-4e67-87cc-6c******d77b",
    "service_name" : "边缘入侵检测",
    "function_version" : "1.0",
    "created_at" : 1680008856502,
    "alg_status" : "service_running",
    "deploy_type" : "edge",
    "alg_class" : "self",
    "request_mode" : "async",
    "can_update" : true,
    "new_alg_id" : "3320b2b9-562b-4bee-bfee-0e******01c1"
  }, {
    "alg_id" : "5c73bd3f-6498-40e5-a40f-7b******1139",
    "service_id" : "04dc08b7-da07-46ee-83e7-c3******f668",
    "service_name" : "test-event-01",
    "function_version" : "1.0",
    "created_at" : 1680005185627,
    "alg_status" : "service_stopped",
    "deploy_type" : "cloud",
    "alg_class" : "self",
    "request_mode" : "async"
  }, {
    "alg_id" : "c01ec07f-874f-42f1-ba1d-15******d71b",
    "service_id" : "db1ec2d2-d023-4d20-ab6f-bc******4eeb",
    "service_name" : "TEST-CLOUD-ALG",
    "function_version" : "1.0",
    "created_at" : 1680008219078,
    "alg_status" : "service_failed",
    "deploy_type" : "cloud",
    "alg_class" : "self",
    "request_mode" : "async",
    "description" : "测试云上算法"
  } ],
  "total" : 3
}

状态码

状态码

描述

200

我的算法服务列表响应体

400

请求错误

500

内部错误
父主题： 算法中心

相关文档