AI开发平台ModelArtsAI开发平台ModelArts

计算
弹性云服务器 ECS
云耀云服务器 HECS
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机 CPH
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
内容分发网络 CDN
存储容灾服务 SDRS
弹性文件服务 SFS
云服务器备份 CSBS
云硬盘备份 VBS
数据快递服务 DES
专属企业存储服务
智能边缘
智能边缘云 IEC
EI 企业智能
EI安视服务
AI开发平台ModelArts
数据湖治理中心 DGC
数据仓库服务 GaussDB(DWS)
企业级AI应用开发专业套件 ModelArts Pro
数据湖探索 DLI
华为HiLens
云搜索服务 CSS
数据接入服务 DIS
表格存储服务 CloudTable
数据湖工厂 DLF
图引擎服务 GES
推荐系统 RES
文字识别 OCR
内容审核 Moderation
图像识别 Image
图像搜索 ImageSearch
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
数据可视化 DLV
视频接入服务 VIS
自然语言处理 NLP
语音交互服务 SIS
知识图谱 KG
医疗智能体 EIHealth
可信智能计算服务 TICS
园区智能体 CampusGo
实时流计算服务 CS
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
IoT物联网
全球SIM联接 GSL
设备发放 IoTDP
IoT开发者服务
IoT边缘 IoTEdge
IoT数据分析
路网数字化服务 DRIS
开发与运维
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
软件开发平台 DevCloud
开源镜像站 Mirrors
视频
媒体处理 MPC
视频点播 VOD
视频直播 Live
实时音视频 SparkRTC
管理与部署
统一身份认证服务 IAM
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云审计服务 CTS
云日志服务 LTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
专属云
专属计算集群 DCC
专属分布式存储服务 DSS
域名与网站
域名注册服务 Domains
云速建站 CloudSite
企业协同
华为云WeLink
会议
ISDP
解决方案
全栈专属服务
高性能计算 HPC
SAP
游戏云
混合云灾备
快视频
华为工业云平台 IMC
价格
价格原则
成本优化最佳实践
昇腾
昇腾MindX SDK (20.3)
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
容器交付流水线 ContainerOps
应用服务网格 ASM
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
容器批量计算 BCE
云原生服务中心 OSC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
文档数据库服务 DDS
分布式数据库中间件 DDM
数据复制服务 DRS
数据管理服务 DAS
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
云数据库 GaussDB (for openGauss)
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
应用中间件
应用管理与运维平台 ServiceStage
分布式缓存服务 DCS
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
消息通知服务 SMN
微服务引擎 CSE
云性能测试服务 CPTS
区块链服务 BCS
API网关 APIG
应用魔方 AppCube
分布式消息服务RocketMQ版
多云高可用服务 MAS
可信跨链数据链接服务 TCDAS
企业应用
云桌面 Workspace
云解析服务 DNS
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
ROMA API
鸿源云道
华为乾坤云服务
安全与合规
Web应用防火墙 WAF
漏洞扫描服务 VSS
企业主机安全 HSS
容器安全服务 CGS
数据加密服务 DEW
数据库安全服务 DBSS
态势感知 SA
云堡垒机 CBH
SSL证书管理 SCM
云证书管理服务 CCM
管理检测与响应 MDR
数据安全中心 DSC
威胁检测服务 MTD
DDoS防护 ADS
云防火墙 CFW
应用信任中心 ATC
安全技术与应用
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
智能协作
IdeaHub
企业网络
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
废弃-华为乾坤安全云服务
云通信
语音通话 VoiceCall
消息&短信 MSGSMS
隐私保护通话 PrivateNumber
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
鲲鹏
昇腾
合作伙伴中心
华为云学院
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
网站备案
支持计划
专业服务
合作伙伴支持计划
更新时间:2021/10/12 GMT+08:00
分享

部署服务

功能介绍

将模型部署为服务。

URI

POST /v1/{project_id}/services

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

参数

是否必选

参数类型

说明

project_id

String

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

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

说明

service_name

String

服务名称,支持1-64位可见字符(含中文),名称可以包含字母、中文、数字、中划线、下划线。

description

String

服务备注,默认为空,不超过100个字符。

infer_type

String

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

  • real-time:实时服务,支持定时停止。
  • batch:批量服务,可配置批量任务运行,任务运行结束则停止。
  • edge表示部署到边缘节点,需提前在IEF(智能边缘服务)创建好节点。

workspace_id

String

服务所属的工作空间ID,默认为“0”,代表默认工作空间。

vpc_id

String

在线服务实例部署的虚拟私有云ID,默认为空。

  • 此时ModelArts会为每个用户分配一个专属的VPC,用户之间隔离;如需要在服务实例中访问名下VPC内的其他服务组件,则可配置此参数为对应VPC的ID。
  • VPC一旦配置,不支持修改。当vpc_id与cluster_id一同配置时,只有专属资源池参数生效。

subnet_network_id

String

子网的网络ID,默认为空。

当配置了vpc_id则此参数必填。需填写虚拟私有云控制台子网详情中显示的“网络ID”。通过子网可提供与其他网络隔离的、可以独享的网络资源。

security_group_id

String

安全组,默认为空,当配置了vpc_id则此参数必填。

安全组起着虚拟防火墙的作用,为服务实例提供安全的网络访问控制策略。安全组须包含至少一条入方向规则,对协议为TCP、源地址为0.0.0.0/0、端口为8080的请求放行。

cluster_id

String

专属资源池ID,默认为空,不使用专属资源池;使用专属资源池部署服务时需确保集群状态正常;配置此参数后,需要使用集群的网络配置,“vpc_id”参数不生效。当与下方real-time config中的cluster_id同时配置时,优先使用real-time config中的cluster_id参数。

config

对应infer_type的config结构数组

模型运行配置,当推理方式为batch/edge时仅支持配置一个模型;当推理方式为real-time时,可根据业务需要配置多个模型并分配权重,但多个模型的版本号不能相同。

schedule

schedule结构数组

服务调度配置,仅在线服务可配置,默认不使用,服务长期运行。请参见表6

additional_properties

Map<String, Object>

服务级别附加属性,便于服务管理。请参见表7

表3 real-time config结构

参数

是否必选

参数类型

说明

model_id

String

模型ID。

weight

Integer

权重百分比,分配到此模型的流量权重,仅当infer_type为real-time时需要配置,多个权重相加必须等于100。

specification

String

资源规格,根据所提供版本选择适合业务的规格。当前版本可选:

  • modelarts.vm.cpu.2u
  • modelarts.vm.gpu.p4
  • modelarts.vm.gpu.t4
  • modelarts.vm.arm.d310.3u6g
  • modelarts.vm.ai1.a310
  • modelarts.vm.cpu.free
  • modelarts.vm.gpu.free

custom_spec

custom_spec结构体

自定义规格。使用专属资源池部署的时候可以使用自定义规格。请参见表12

instance_count

Integer

模型部署的实例数。实例数取值必须大于0。

envs

Map<String, String>

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

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

cluster_id

string

专属资源池ID,默认为空,不使用专属资源池。配置此参数后,需要使用集群的网络配置,“vpc_id”参数不生效。

additional_properties

Map<String, Object>

模型部署附加属性,便于服务实例管理。请参见表9

表4 batch config结构

参数

是否必选

参数类型

说明

model_id

String

模型ID。

specification

String

资源规格,当前版本可选modelarts.vm.cpu.2u/modelarts.vm.gpu.p4。

instance_count

Integer

模型部署的实例数。

envs

Map<String, String>

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

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

src_type

String

数据来源类型,可选填ManifestFile。默认为空,表示只读取src_path目录下的文件。当取值为ManifestFile时,src_path必须为具体的manifest路径,在manifest文件中可指定多个数据路径(参考推理manifest规范)。

src_path

String

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

dest_path

String

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

req_uri

String

批量任务中调用的推理接口,即模型镜像中暴露的REST接口,需要从模型的“config.json”文件中选取一个api路径用于此次推理;如使用ModelArts提供的预置推理镜像,则此接口为“/”

mapping_type

String

输入数据的映射类型,可选“file”“csv”

  • file指每个推理请求对应到输入数据目录下的一个文件,当使用此方式时,此模型对应req_uri只能有一个输入参数且此参数的类型是file。
  • 选择csv时指每个推理请求对应到csv里的一行数据,当使用此方式时,输入数据目录下的文件只能以.csv为后缀,且需配置mapping_rule参数,以表达推理请求体中各个参数对应到csv的索引。

mapping_rule

Map

输入参数与csv数据的映射关系,仅当“mapping_type”“csv”时需要填写。

映射关系生成规则:映射规则来源于模型配置文件“config.json”中输入参数(input_params)。当“type”定义为“string/number/integer/boolean”基本类型时,需要配置映射规则参数,即index参数。具体示例可参见映射关系示例

index必须从0开始的正整数,当index设置不符合规则时,最终的请求将忽略此参数。配置映射规则后,其对应的csv数据必须以英文半角逗号分隔。

表5 edge config结构

参数

是否必选

参数类型

说明

model_id

String

模型ID。

specification

String

资源规格,当前版本可选modelarts.vm.cpu.2u/modelarts.vm.gpu.p4。

envs

Map<String, String>

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

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

nodes

String数组

边缘节点ID数组。

表6 schedule结构

参数

是否必选

参数类型

说明

type

String

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

time_unit

String

调度时间单位,可选:

  • DAYS
  • HOURS
  • MINUTES

duration

Integer

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

表7 服务级别additional_properties已有属性

参数

是否必选

参数类型

说明

smn_notification

smn_notification结构

smn消息通知结构,用于通知用户服务状态变化。请参见表8

表8 smn_notification结构

参数

是否必选

参数类型

说明

topic_urn

String

smn主题urn地址。

events

List<Integer>

事件ID,目前已有事件ID如下。

  • 1:failed
  • 3:running
  • 7:concerning
  • 11:pending
表9 模型级别additional_properties已有属性

参数

是否必选

参数类型

说明

persistent_volumes

persistentVolume数组结构

持久化存储挂载配置。请参见表10

log_volume

logVolume数组结构

主机日志目录挂载。请参见表11

仅支持使用专属资源池部署服务场景。如果用户使用公共资源池部署服务,则不支持配置该参数,否则会报错。

表10 persistentVolume结构

参数

是否必选

参数类型

说明

name

String

云镜像名称。

mount_path

String

云镜像在容器中的挂载路径。

表11 logVolume结构

参数

是否必选

参数类型

说明

host_path

String

主机上要映射的日志路径。

mount_path

String

容器中的日志路径。

表12 custom_spec自定义规格结构

参数

是否必选

参数类型

说明

cpu

Float

要求的CPU数量。

memory

Integer

要求的内存数量,单位MB。

gpu_p4

Float

GPU个数,可选,默认不使用,支持配置小数。

ascend_a310

Integer

NPU个数,可选,默认不使用,支持配置小数。

响应消息

响应参数如表13所示。
表13 响应参数

参数

参数类型

说明

service_id

String

服务ID。

resource_ids

Array of strings

资源id数组,服务对应的模型生成的资源ID。

示例

如下为部署不同类型服务的样例。

  • 请求示例,创建在线服务
    POST    https://endpoint/v1/{project_id}/services
    {
      "service_name": "mnist",
      "description": "mnist service",
      "infer_type": "real-time",
      "config": [
        {
          "model_id": "xxxmodel-idxxx",
          "weight": "100",
          "specification": "modelarts.vm.cpu.2u",
          "instance_count": 1
        }
      ]
    }
  • 请求示例,创建在线服务且配置多版本分流
    {
      "service_name": "mnist",
      "description": "mnist service",
      "infer_type": "real-time",
      "config": [
        {
          "model_id": "xxxmodel-idxxx",
          "weight": "70",
          "specification": "modelarts.vm.cpu.2u",
          "instance_count": 1,
          "envs":
          {
              "model_name": "mxnet-model-1",
              "load_epoch": "0"
          }
        },
        {
          "model_id": "xxxxxx",
          "weight": "30",
          "specification": "modelarts.vm.cpu.2u",
          "instance_count": 1
        }
      ]
    }
  • 请求示例,创建专属资源池自定义规格在线服务样例
    {
    	"service_name": "realtime-demo",
    	"description": "",
    	"infer_type": "real-time",
    	"cluster_id": "8abf68a969c3cb3a0169c4acb24b0000",
    	"config": [{
    		"model_id": "eb6a4a8c-5713-4a27-b8ed-c7e694499af5",
    		"weight": "100",
    		"cluster_id": "8abf68a969c3cb3a0169c4acb24b0000",
    		"specification": "custom",
    		"custom_spec": {
    			"cpu": 1.5,
    			"memory": 7500,
    			"gpu_p4": 0,
    			"ascend_a310": 0
    		},
    		"instance_count": 1
    	}]
    }
  • 请求示例,创建在线服务设置自动停止
    {
    	"service_name": "service-demo",
    	"description": "demo",
    	"infer_type": "real-time",
    	"config": [{
    		"model_id": "xxxmodel-idxxx",
    		"weight": "100",
    		"specification": "modelarts.vm.cpu.2u",
    		"instance_count": 1
    	}],
    	"schedule": [{
    		"type": "stop",
    		"time_unit": "HOURS",
    		"duration": 1
    	}]
    }
  • 请求示例,创建批量服务且输入数据映射方式为“file”
    {
    "service_name": "batchservicetest",
    "description": "",
    "infer_type": "batch",
    "cluster_id": "8abf68a969c3cb3a0169c4acb24b****",
    "config": [{
        "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
        "specification": "modelarts.vm.cpu.2u",
        "instance_count": 1,
        "src_path": "https://infers-data.obs.cn-north-4.myhuaweicloud.com/xgboosterdata/",
        "dest_path": "https://infers-data.obs.cn-north-4d.com/output/",
        "req_uri": "/",
        "mapping_type": "file"
    }]
    }
  • 请求示例,创建批量服务且输入数据映射方式为“csv”
    {
    "service_name": "batchservicetest",
    "description": "",
    "infer_type": "batch",
    "config": [{
        "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
        "specification": "modelarts.vm.cpu.2u",
        "instance_count": 1,
        "src_path": "https://infers-data.obs.cn-north-4.myhuaweicloud.com/xgboosterdata/",
        "dest_path": "https://infers-data.obs.cn-north-4.myhuaweicloud.com.com/output/",
        "req_uri": "/",
        "mapping_type": "csv",
        "mapping_rule": {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "req_data": {
                            "type": "array",
                            "items": [{
                                "type": "object",
                                "properties": {
                                    "input5": {
                                        "type": "number",
                                        "index": 0
                                    },
                                    "input4": {
                                        "type": "number",
                                        "index": 1
                                    },
                                    "input3": {
                                        "type": "number",
                                        "index": 2
                                    },
                                    "input2": {
                                        "type": "number",
                                        "index": 3
                                    },
                                    "input1": {
                                        "type": "number",
                                        "index": 4
                                    }
                                }
                            }]
                        }
                    }
                }
            }
        }
    }]
    }
    示例中“mapping_rule”描述的推理请求体格式为:
    {
    "data": {
        "req_data": [{
            "input1": 1,
            "input2": 2,
            "input3": 3,
            "input4": 4,
            "input5": 5
        }]
    }
    }
  • 请求示例,创建边缘服务样例
    {
    	"service_name": "service-edge-demo",
    	"description": "",
    	"infer_type": "edge",
    	"config": [{
    		"model_id": "eb6a4a8c-5713-4a27-b8ed-c7e694499af5",
    		"specification": "custom",
    		"custom_spec": {
    			"cpu": 1.5,
    			"memory": 7500,
    			"gpu_p4": 0,
    			"ascend_a310": 0
    		},
                    "envs":{},
    		"nodes": ["2r8c4fb9-t497-40u3-89yf-skui77db0472"]
    	}]
    }
  • 响应示例
    {
      "service_id": "10eb0091-887f-4839-9929-cbc884f1e20e",
      "resource_ids": [     "INF-f878991839647358@1598319442708"   ]
    }

状态码

状态码请参见表1

分享:

    相关文档

    相关产品