更新时间:2022-09-22 GMT+08:00
分享

查询服务详情

功能介绍

查询模型服务详情,根据服务ID查询服务详情。

URI

GET /v1/{project_id}/services/{service_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

参数类型

说明

project_id

String

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

service_id

String

服务ID。

请求消息

无请求参数。

响应消息

响应参数如表2所示。
表2 参数说明

参数

参数类型

说明

service_id

String

服务ID。

service_name

String

服务名称。

description

String

服务描述。

tenant

String

服务归属租户。

project

String

服务归属项目。

owner

String

服务归属用户。

publish_at

Number

服务最新的发布时间,距'1970.1.1 0:0:0 UTC'的毫秒数。

infer_type

String

推理方式,取值为real-time/batch/edge。

workspace_id

String

工作空间ID。

cluster_id

String

在线/批量服务使用的专属资源池ID,仅当配置专属资源池时返回。

vpc_id

String

在线服务实例所在的虚拟私有云ID,服务自定义网络配置时返回。

subnet_network_id

String

在线服务实例所在的子网的网络ID,服务自定义网络配置时返回。

security_group_id

String

在线服务实例所在的安全组,服务自定义网络配置时返回。

status

String

服务状态,取值为running/deploying/concerning/failed/stopped/finished。

progress

Integer

部署进度,当状态是deploying时返回。

error_msg

String

错误信息,当status为failed时,返回这个信息注明失败原因。

config

不同infer_type的config结构数组

服务配置(如果是共享过来的服务,只返回model_id ,model_name, model_version)。

  • 当infer_type为real-time时参见表3
  • 当infer_type为batch时参见表4
  • 当infer_type为edge时参见表5

access_address

String

推理请求的访问地址,当infer_type为real-time时会返回此值。

bind_access_address

String

自定义域名的推理请求地址,绑定域名后会返回此值。

invocation_times

Number

服务的总调用次数。

failed_times

Number

服务调用失败次数。

is_shared

Boolean

是否是订阅的服务。

shared_count

Number

订阅的服务数。

schedule

schedule结构数组

服务调度配置,未配置则不返回。请参见表7

update_time

Number

服务当前运行所用配置的更新时间,距'1970.1.1 0:0:0 UTC'的毫秒数。

debug_url

String

在线服务在线调试地址,只有当模型支持在线调试且只有一个实例的时候会存在。

due_time

number

在线服务自动停止时间,距'1970.1.1 0:0:0 UTC'的毫秒数。

operation_time

number

当前请求的操作时间。

transition_at

number

服务状态转化时间。

is_free

Boolean

服务是否是免费规格类型。

additional_properties

Map<String, Object>

服务附加属性。

表3 real-time config结构

参数

参数类型

说明

model_id

String

模型ID。

model_name

String

模型名称。

model_version

String

模型版本。

source_type

String

模型来源,当模型是由自动学习产生时返回此字段,取值为“auto”

status

String

模型实例运行状态。取值为如下。

  • ready:已就绪(所有实例已启动)
  • concerning:部分就绪(部分实例已启动、部分实例未启动)
  • notReady:未就绪(所有实例都没启动)

weight

Integer

权重,分配到此模型的流量权重。

specification

String

资源规格,取值为modelarts.vm.cpu.2u/modelarts.vm.gpu.p4/modelarts.vm.ai1.a310。

custom_spec

Object

自定义规格。详情参见表8

envs

Map<String, String>

运行模型需要的环境变量键值对,可选填。

为确保您的数据安全,在环境变量中,请勿输入敏感信息,如明文密码。

instance_count

Integer

模型部署的实例数。

scaling

Boolean

是否启用弹性伸缩。

cluster_id

String

服务实例使用的专属资源池ID,仅当配置专属资源池时返回。

support_debug

Boolean

模型是否支持在线调试。

additional_properties

Map<String, Object>

模型部署附加属性。

表4 batch config结构

参数

参数类型

说明

model_id

String

模型ID。

model_name

String

模型名称。

model_version

String

模型版本。

specification

String

资源规格,取值为modelarts.vm.cpu.2u/modelarts.vm.gpu.p4/modelarts.vm.ai1.a310。

custom_spec

Object

自定义规格。详情参见表8

envs

Map<String, String>

运行模型需要的环境变量键值对,可选填。

为确保您的数据安全,在环境变量中,请勿输入敏感信息,如明文密码。

instance_count

Integer

模型部署的实例数。

src_type

String

数据来源类型,仅当指定为ManifestFile时返回。

src_path

String

批量任务输入数据的OBS路径。

dest_path

String

批量任务输出结果的OBS路径。

req_uri

String

批量任务中调用的推理路径。

mapping_type

String

输入数据的映射类型,取值为file或csv。

mapping_rule

Map

输入参数与csv数据的映射关系,仅当mapping_type为csv时会返回。

start_time

Number

任务启动时间,距'1970.1.1 0:0:0 UTC'的毫秒数;任务未开始时不返回。

finished_time

Number

任务完成时间,距'1970.1.1 0:0:0 UTC'的毫秒数;任务未结束时不返回。

表5 edge config结构

参数

参数类型

说明

model_id

String

模型ID。

model_name

String

模型名称。

model_version

String

模型版本。

specification

String

资源规格,取值为modelarts.vm.cpu.2u/modelarts.vm.gpu.p4。

envs

Map<String, String>

运行模型需要的环境变量键值对。

为确保您的数据安全,在环境变量中,请勿输入敏感信息,如明文密码。

nodes

node结构数组

节点信息。详情参见表6

表6 node结构

参数

参数类型

说明

id

String

节点ID。

name

String

节点名称。

instance_status

String

模型实例在该节点的运行状态,取值为running/stopped/notReady/failed。

predict_url

String

在该节点的预测URL。

node_label

String

节点标签。

description

String

描述。

host_name

String

节点主机名。

os_name

String

节点操作系统名称。

os_type

String

节点操作系统类型。

os_version

String

节点操作系统版本。

arch

String

节点架构。

cpu

Integer

CPU核心数。

memory

Integer

内存数(MB)。

gpu_num

Integer

gpu个数。

enable_gpu

String

是否开启GPU。

host_ips

String数组

节点主机IP。

deployment_num

Integer

部署在该节点上的应用实例个数。

state

String

主机状态,取值如下。

  • RUNNING:运行中
  • FAIL:故障
  • UNCONNECTED:未连接

created_at

String

创建时间,格式为YYYY-MM-DDThh:mm:ss,UTC时间。

updated_at

String

更新时间,格式为YYYY-MM-DDThh:mm:ss,UTC时间。

表7 schedule结构

参数

参数类型

说明

type

String

调度类型,当前仅支持取值为“stop”

time_unit

String

调度时间单位,可选:

  • DAYS
  • HOURS
  • MINUTES

duration

Integer

对应时间单位的数值,比如2小时后停止,则“time_unit”“HOURS”“duration”“2”

表8 custom_spec自定义规格结构

参数

参数类型

说明

cpu

Float

CPU数量。

memory

Integer

内存数量,单位MB。

gpu_p4

Float

GPU数量。

ascend_a310

Integer

Ascend芯片个数。

请求示例

如下以根据服务ID查询“real-time”类型的服务详情为例。

GET    https://endpoint/v1/{project_id}/services/{service_id}

响应示例

{
	"service_id": "f76f20ba-78f5-44e8-893a-37c8c600c02f",
	"service_name": "service-demo",
	"tenant": "xxxxx",
	"project": "xxxxx",
	"owner": "xxxxx",
	"publish_at": 1585809231902,
	"update_time": 1585809358259,
	"infer_type": "real-time",
	"status": "running",
	"progress": 100,
	"access_address": "https://xxxxx.apigw.cn-north-7.myhuaweicloud.com/v1/infers/088458d9-5755-4110-97d8-1d21065ea10b/f76f20ba-78f5-44e8-893a-37c8c600c02f",
	"cluster_id": "088458d9-5755-4110-97d8-1d21065ea10b",
	"workspace_id": "0",
	"additional_properties": {},
	"is_shared": false,
	"invocation_times": 0,
	"failed_times": 0,
	"shared_count": 0,
	"operation_time": 1586249085447,
	"config": [{
		"model_id": "044ebf3d-8bf4-48df-bf40-bad0e664c1e2",
		"model_name": "jar-model",
		"model_version": "1.0.1",
		"specification": "custom",
		"custom_spec": {},
		"status": "notReady",
		"weight": 100,
		"instance_count": 1,
		"scaling": false,
		"envs": {},
		"additional_properties": {},
		"support_debug": false
	}],
	"transition_at": 1585809231902,
	"is_free": false
       
}

状态码

状态码请参见表1

分享:

    相关文档

    相关产品

close