CreateDeployment - 创建部署任务

更新时间:
复制 MD 格式

创建部署任务。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pailangstudio:CreateDeployment

create

*全部资源

*

无 无

请求语法

POST /api/v1/langstudio/deployments HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

否

请求体。

WorkspaceId

string

否

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。

478**

Accessibility

string

否

工作空间可见性,可能值为:

  • PRIVATE:在此工作空间中,仅对您和管理员可见。

  • PUBLIC:在此工作空间中,对所有人可见。

枚举值:

  • PUBLIC :

    对当前工作空间中的所有人可见

  • PRIVATE :

    仅对当前工作空间中的本人和管理员可见

PRIVATE

ResourceType

string

否

待部署的资源类型。取值:

  • Flow: 工作流的项目

  • Code: 代码模式的项目

Flow

ResourceId

string

否

待部署的资源 ID。

flow-asdf******123

ResourceSnapshotId

string

否

待部署资源的快照 ID。若提供该参数,系统将直接基于该快照进行部署;若未提供,系统会先为资源创建新快照,再执行部署。

snap-asfg******123

ServiceName

string

否

服务名字。格式要求:

  • 支持小写字母、数字和下划线

  • 必须以字母开头

  • 长度 1-45 个字符

myservice01

Description

string

否

服务描述。

This is description

EnableTrace

boolean

否

是否启用链路追踪。

true

ChatHistoryConfig

object

否

对话历史配置。

StorageType

string

否

存储方式。取值:

  • LOCAL: 对话历史保存在本地 SQLite 文件,不支持多实例的部署方式。

  • OSS:对话历史保存在服务 OSS 工作路径下特定的路径下。

  • RDS:对话历史保存在 RDS 的表中,需要指定一个 RDS 连接。

枚举值:

  • RDS :

    RDS 数据库

  • LOCAL :

    本地 SQLite 文件

  • OSS :

    OSS 存储

RDS

ConnectionName

string

否

连接名称。对话历史存储方式为 RDS 的时候需要指定该参数。

rdsconnection

WorkDir

string

否

服务的 OSS 工作目录。用于存储服务的运行日志、对话历史等。

oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/

ContentModerationConfig

object

否

内容审核配置。

EnableInputModeration

boolean

否

是否启用对输入的安全审查。

true

EnableOutputModeration

boolean

否

是否启用对输出的内容审查。

true

StreamingModerationThreshold

integer

否

流式输出内容送审缓存大小,默认为 5。

5

DeploymentConfig

string

否

部署配置。具体参考 PAI-EAS 的部署配置。

{\"metadata\":{\"name\":\"langstudio_2026******3848_jro7\",\"instance\":1,\"workspace_id\":\"285***\",\"enable_webservice\":false},\"cloud\":{\"computing\":{\"instances\":[{\"type\":\"ecs.g7.xlarge\"}]},\"networking\":{\"vpc_id\":\"vpc-bp1obprt******4bzo00d\",\"vswitch_id\":\"vsw-bp1p6i36k******pmfhw8\",\"security_group_id\":\"sg-bp1djud4******zecl5a\"}}}

AutoApproval

boolean

否

是否自动跳过部署确认环节。

true

返回参数

名称

类型

描述

示例值

object

返回结果。

DeploymentId

string

部署记录 ID。

dploy-asdf******1234

RequestId

string

请求 ID

963BD7F9-0C02-5594-9550-BCC6DD43E3C0

示例

正常返回示例

JSON格式

{
  "DeploymentId": "dploy-asdf******1234",
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

错误码

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

变更历史

更多信息,参考变更详情。