文档首页/ 视频智能分析服务 VIAS/ API参考/ 平台API/ 算法中心/ 获取服务详情 - ShowServiceDetail
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取服务详情 - ShowServiceDetail

功能介绍

获取服务详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

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，获取方法参见认证鉴权。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：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

  • VCN

  • URL

  • Restful

  • 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]。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

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/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" : [ "1.0.1" ],
  "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", "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

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

相关文档