我的算法服务列表 - ListUserServices
功能介绍
我的算法服务列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/algorithm/services/user
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 用户项目ID,获取方法参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name_like | 否 | String | 参数解释: 服务名称,支持模糊匹配。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_paged | 否 | Boolean | 参数解释: 是否分页。 约束限制: 不涉及。 取值范围:
默认取值: false |
page_size | 否 | Integer | 参数解释: 每页的最大条目数。 约束限制: 不涉及。 取值范围: 5-200 默认取值: 10 |
page_num | 否 | Integer | 参数解释: 第几页。 约束限制: 不涉及。 取值范围: 1-10000 默认取值: 1 |
order_by | 否 | String | 参数解释: 排序方式。 约束限制: 不涉及。 取值范围:
默认取值: desc |
sort_name | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及。 取值范围:
默认取值: created_at |
alg_status | 否 | Array of strings | 参数解释: 服务状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token,获取方法参见认证鉴权。 约束限制: 不涉及。 取值范围: 字符串长度[0, 32768]。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 数量。 取值范围: 不涉及。 |
service_list | Array of ServicesListInfoDto objects | 参数解释: 服务列表。 取值范围: 不涉及。 |
total | Integer | 参数解释: 总数数量。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
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 | 参数解释: 算法状态。 取值范围:
|
deploy_type | String | 参数解释: 部署类型。 取值范围:
|
alg_class | String | 参数解释: 算法类别。 取值范围:
|
request_mode | String | 参数解释: 请求模式。 取值范围:
|
description | String | 参数解释: 算法描述,信息非空时返回。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 服务异常信息,信息非空时返回。 取值范围: 不涉及。 |
can_update | Boolean | 参数解释: 是否可升级,值为true时返回。 取值范围:
|
new_alg_id | String | 参数解释: 升级后的算法ID,可升级时返回。 取值范围: 不涉及。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
请求示例
我的算法服务列表,过滤出状态为“运行中”、“已停止”或“部署异常”的服务
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,
"company" : "HW",
"description" : "description",
"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,
"company" : "HW",
"description" : "description",
"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,
"company" : "HW",
"alg_status" : "service_failed",
"deploy_type" : "cloud",
"alg_class" : "self",
"request_mode" : "async",
"description" : "测试云上算法"
} ],
"total" : 3
} 状态码
状态码 | 描述 |
|---|---|
200 | 我的算法服务列表响应体。 |
400 | 请求错误。 |
500 | 内部错误。 |

