文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 算法中心/ 获取服务详情
更新时间：2024-04-22 GMT+08:00
查看PDF
分享

获取服务详情

功能介绍

获取服务详情

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID，获取方法参见获取项目ID和名称

service_id

是

String

服务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

service_id

String

服务ID

service_name

String

服务名称

logo

String

算法图标，Base64编码格式的字符串，非空时返回

function_version

String

功能版本

release_flag

Boolean

是否已发布，取值为“true”或者“false”

description

String

算法描述，非空时返回

created_at

Long

创建时间

updated_at

Long

更新时间

release_at

Long

发布时间

api

String

API

pool_id

String

资源池ID

alg_name

String

算法名称

alg_id

String

算法ID

request_mode

String

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

package_name

String

算法包名称

package_id

String

算法包ID

alg_version

String

算法版本

alg_versions

Array of strings

算法历史版本

diagram

String

算法场景图，Base64编码格式的字符串，非空时返回

service_api_list

Array of ServiceApiDto objects

服务API列表

deployment_constraints

DeploymentConstraintsDto object

模型部署约束

company

String

厂商名称

tags

Array of strings

应用场景标签

deploy_type

String

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

alg_class

String

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

alg_status

String

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

error_msg

String

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

参数

参数类型

描述

request_type

String

请求类型，get, post

zh

String

中文描述

en

String

英文描述

request_url

String

请求url
表5 DeploymentConstraintsDto

参数

参数类型

描述

request_mode

String

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

cpu_type

String

CPU类型，取值为“x86_64”或者“aarch64”

accelerators

Array of AcceleratorsDto objects

推理加速卡

input_types

Array of strings

支持的输入类型，列表元素取值为“OBS”、“URL”、“Restful”、“VCN”、“EdgeCamera”

output_types

Array of strings

支持的输出类型，列表元素取值为“OBS”、“DIS”或者“Webhook”

service_config

String

服务启动参数

task_config

String

作业配置参数
表6 AcceleratorsDto

参数

参数类型

描述

type

String

加速卡类型

最小长度：1

最大长度：256

name

String

加速卡名称

最小长度：1

最大长度：256

cuda_version

String

CUDA版本

最小长度：1

最大长度：256

driver_version_section

String

昇腾驱动版本

最小长度：1

最大长度：256

请求示例

获取服务详情

GET https://{endpoint}/v2/{project_id/algorithm/services/331bcb4a-5b3c-4e67-87cc-6c******d77b

响应示例

状态码： 200

服务详情响应体

{
  "service_id" : "331bcb4a-5b3c-4e67-87cc-6c******d77b",
  "service_name" : "边缘入侵检测",
  "logo" : "data:image/png;base64,xxxxxx",
  "function_version" : "1.0",
  "release_flag" : true,
  "created_at" : 1680008856502,
  "updated_at" : 1680004378199,
  "release_at" : 1680004378199,
  "api" : "c-int******ion-edge",
  "pool_id" : "ed9f128bf7d04f5683f0ef******a255",
  "alg_name" : "边缘入侵检测",
  "alg_id" : "068ed4d8-077e-4ec9-aa19-bc******e925",
  "package_id" : "9a2423e3-02d3-4305-b491-d6******51bd",
  "alg_version" : "1.0.1",
  "alg_versions" : [ ],
  "diagram" : "data:image/png;base64,xxxxxx",
  "service_api_list" : [ {
    "request_type" : "POST",
    "zh" : "创建作业",
    "en" : "create task",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/services/c-int******ion-edge/tasks"
  }, {
    "request_type" : "GET",
    "zh" : "作业详情",
    "en" : "task detail",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/tasks/{task_id}"
  }, {
    "request_type" : "GET",
    "zh" : "作业列表",
    "en" : "task list",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/tasks"
  }, {
    "request_type" : "DELETE",
    "zh" : "删除作业",
    "en" : "delete task",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/tasks/{task_id}"
  }, {
    "request_type" : "PUT",
    "zh" : "作业启动",
    "en" : "start task",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/tasks/{task_id}/action/start"
  }, {
    "request_type" : "PUT",
    "zh" : "作业停止",
    "en" : "stop task",
    "request_url" : "/v2/41be0da3412b4a569409dcec43983908/tasks/{task_id}/action/stop"
  } ],
  "deployment_constraints" : {
    "request_mode" : "async",
    "cpu_type" : "x86_64",
    "accelerators" : [ {
      "type" : "gp",
      "name" : "Tnt004",
      "cuda_version" : "cuda 10.2"
    } ],
    "input_types" : [ "Restful", "VCN", "EdgeCamera" ],
    "output_types" : [ "Webhook" ],
    "service_config" : "<?xml version=\"1.0\" encoding=\"UTF-8\"?><algorithm><deployConfig> <param name=\"sub_scene\" titleCn=\"子场景\" titleEn=\"sub scene\" required=\"false\" type=\"String\" default=\"common\"/></deployConfig></algorithm>",
    "task_config" : "<algorithm><config><common/></config></algorithm>"
  },
  "alg_scene" : "other",
  "deploy_type" : "edge"
}

状态码

状态码

描述

200

服务详情响应体

400

请求错误

500

内部错误

错误码

请参见错误码。

父主题： 算法中心