CreateService - 创建服务

创建PAI-EAS服务。

接口说明

请确保在使用该接口前,已充分了解 EAS 产品的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eas:CreateServicecreate
*Service
acs:eas:{#regionId}:{#accountId}:service/*

请求语法

POST /api/v2/services HTTP/1.1

请求参数

名称类型必填描述示例值
bodystring

请求 body。其中关键请求参数配置说明,请参见下方的表 1. 请求 Body 参数表 2. metadata 参数。更多参数配置详情,请参见服务模型所有相关参数说明

镜像部署服务: { "name": "foo", "metadata": { "instance": 2, "memory": 7000, "cpu": 4 }, "containers": [ { "image": "****", "script": "**** --listen=0.0.0.0 --server_port=8000 --headless", "port": 8000 } ], "storage": [ { "oss": { "path": "oss://examplebuket/data111/", "readOnly": false }, "properties": { "resource_type": "model" }, "mount_path": "/data" } ] } 镜像部署AI-Web应用: { "name": "foo", "metadata": { "instance": 1, "memory": 7000, "cpu": 4, "enable_webservice": true }, "containers": [ { "image": "****", "script": "**** --listen=0.0.0.0 --server_port=8000 --headless", "port": 8000 } ], "storage": [ { "oss": { "path": "oss://examplebucket/data111/", "readOnly": false }, "properties": { "resource_type": "model" }, "mount_path": "/data" } ] } 模型+processor部署服务: { "metadata": { "instance": 1, "memory": 7000, "cpu": 4 }, "name": "foo", "model_config": {}, "processor_type": "python", "processor_path": "oss://****", "processor_entry": "a.py", "model_path": "oss://****" }
Developstring

是否进入开发模式。

枚举值:
  • true进入开发模式
  • false不进入开发模式
true
Labelsobject

用户自定义标签。

string

标签。

{"key":"value"}
WorkspaceIdstring

工作空间 ID。

123456

表 1. 请求 Body 参数

名称类型是否必选说明
nameString服务名称,在同一个地域内全局唯一。
tokenString指定用于访问鉴权的 Token 字符串,若不指定则按generate_token自动生成。
model_pathString模型相关的文件,支持 HTTP 和 OSS 两种格式,HTTP 地址需为 Public 可访问的。若为 OSS 地址,则输入可以是目录或者文件;若文件为.tar.gz.tar.bz2.zip等压缩包,会自动解压。
role_arnstringmodel_pathprocessor_path为 OSS 地址时,需要指定用于 OSS 授权的 role_arn,role_arn 的获取参数 Role_ARN。
oss_endpointStringmodel_pathprocessor_path为 OSS 地址时,需要指定 OSS Bucket 对应的 endpoint。
model_entryString模型的入口文件,若不指定,则使用model_path中的文件名,可以包含任意文件,主文件的路径会传递给 Processor 中的Load()函数。
processor_pathStringProcessor 相关的文件包,支持本地文件和 HTTP 链接地址,若文件为.tar.gz.tar.bz2.zip等压缩包,会自动解压。
processor_entryStringC、C++、Python 类型必选。Processor 的主文件,其中包含了预测所需要Load()函数和Process()函数的实现。
processor_mainclassStringJava 类型必选。Processor 的主文件,JAR 包中的 mainclass。
processor_typeStringprocessor 实现的语言,目前已支持 C、C++、Java、Python。
metadataDict服务的 meta 信息。详见下表 2。
cloudDict目前只有指定机型部署时会用到,传参的样式为"cloud":{"computing":{"instance_type": "ecs.gxxxxxx.large"}}
containersList自定义镜像部署。如果 Processor 部署无法满足需求,可以使用自定义镜像部署,详情请参见服务部署:自定义镜像
说明 model_path 和 processor_path 为输入模型数据和 processor 数据的数据来源,支持 HTTP 和 OSS 两种数据源,使用 test 命令进行本地调试时支持本地文件和目录。
  • 若使用 HTTP 地址,则需要将相关文件打包成.tar.gz、.tar.bz2、.zip 等压缩包,可上传至 OSS 并生成 HTTP 地址。
  • 若使用 OSS 地址,则输入可以是目录,也可以是文件。

表 2. metadata 参数

名称类型是否必选描述示例值
instanceInt服务启动的 Worker 数目。1
cpuInt每个 Worker 需要的 CPU 数目。1
gpuInt每个 Worker 需要的 GPU 数目。0
memoryInt每个 Worker 需要的内存大小,单位为 MB。1000
resourceString服务所属的资源组。eas-r-aaabbbccc
rpc.worker_threadsInt每个 Instance 中用于并发处理请求的线程数。5
rpc.max_queue_sizeInt请求处理时队列的最大长度,队列满时新请求会被以 450 状态码丢弃。64
rpc.keepaliveInt请求的超时时间,单位为毫秒。5000
rpc.rate_limitInt单实例请求限流的 QPS 值,单实例 QPS 超出该值后的请求会被返回 429 丢弃。0
releaseBool若为 true,则要创建一个灰度发布服务。false

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

40325405-579C-4D82****
ServiceIdstring

新创建服务的服务 ID。

eas-m-aaxxxddf
ServiceNamestring

新创建服务的服务名字。

yourname
Statusstring

新服务的当前状态。

Creating
Regionstring

新创建服务所属的区域 ID。

cn-shanghai
InternetEndpointstring

新创建服务的公网 Endpoint。

http://pai-eas.vpc.cn-shanghai.****
IntranetEndpointstring

新创建服务的内网 Endpoint。

http://pai-eas.cn-shanghai.****

示例

正常返回示例

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "ServiceId": "eas-m-aaxxxddf",
  "ServiceName": "yourname",
  "Status": "Creating",
  "Region": "cn-shanghai",
  "InternetEndpoint": "http://pai-eas.vpc.cn-shanghai.****",
  "IntranetEndpoint": "http://pai-eas.cn-shanghai.****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-01OpenAPI 入参发生变更查看变更详情
2023-01-04OpenAPI 入参发生变更查看变更详情