AI 助理
文档备案控制台
官方文档
首页 人工智能平台 PAI 开发参考 API参考 大模型应用开发 API API目录 部署任务 GetDeployment - 获取部署任务详情

GetDeployment - 获取部署任务详情

更新时间：
复制 MD 格式
产品详情
我的收藏

获取部署任务详情。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

pailangstudio:GetDeployment

get

*全部资源

*

 无 无

请求语法

GET /api/v1/langstudio/deployments/{DeploymentId} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值
DeploymentId

string

否

部署任务 ID。

dploy-asdf******1234

请求参数

名称

类型

必填

描述

示例值
WorkspaceId

string

否

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

478***

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID

963BD7F9-0C02-5594-9550-BCC6DD43E3C0
WorkspaceId

string

工作空间 ID。

478***
Accessibility

string

工作空间可见性，可能值为：

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

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

PRIVATE
Creator

string

创建者 ID。

2003******4844
GmtCreateTime

string

创建时间，采用 ISO 8601 格式的 UTC 时间。

2025-09-24T07:33:53Z
GmtModifiedTime

string

最后修改时间，采用 ISO 8601 格式的 UTC 时间。

2025-09-24T08:58:35Z
DeploymentId

string

部署任务 ID。

dploy-asdf******1234
DeploymentStatus

string

部署任务状态。取值：

  • Creating：创建中。

  • Failed：部署失败。

  • Stopping：停止中。

  • Waiting：等待中。

  • Starting：启动中。

  • Running：运行中。

  • Pending：等待中。

  • WaitForConfirm: 等待确认。

  • Canceled：取消。

  • Succeed：成功。

Succeed
OperationType

string

操作类型。取值：

  • Create： 新建服务。

  • Update： 更新已有服务。

Create
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
WorkDir

string

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

oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/
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
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\"}}}
DeploymentStages

array<object>

部署的阶段信息。

object

Stage

integer

部署阶段。

1
StageName

string

部署阶段名称。

PrepareSnapshot
Description

string

部署阶段描述。

Create snapshot for deployment
GmtStartTime

string

部署阶段开始时间，采用 ISO 8601 格式并包含时区偏移。

2025-09-23T10:25:38+08:00
GmtEndTime

string

部署阶段结束时间，采用 ISO 8601 格式并包含时区偏移。

2025-09-23T10:35:38+08:00
StageStatus

string

部署阶段状态。取值：

  • NotStarted： 未开始。

  • WaitForConfirm：等待确认。

  • Waiting： 等待中。

  • Creating： 创建中。

  • Running： 运行中。

  • Succeed： 成功。

  • Failed： 失败。

  • Canceled：取消。

Running
ErrorMessage

string

错误信息。

This is error
StageInfo

string

部署阶段信息。

{\"SnapshotId\":\"snap-i8j29kw8nubqb0hotn\"}
ErrorMessage

string

错误信息。

This is error message
AutoApproval

boolean

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

true

示例

正常返回示例

JSON格式

{
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0",
  "WorkspaceId": "478***",
  "Accessibility": "PRIVATE",
  "Creator": "2003******4844",
  "GmtCreateTime": "2025-09-24T07:33:53Z",
  "GmtModifiedTime": "2025-09-24T08:58:35Z",
  "DeploymentId": "dploy-asdf******1234",
  "DeploymentStatus": "Succeed",
  "OperationType": "Create",
  "ResourceType": "Flow",
  "ResourceId": "flow-asdf******123",
  "ResourceSnapshotId": "snap-asfg******123",
  "ServiceName": "myservice01",
  "Description": "This is description",
  "WorkDir": "oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/",
  "EnableTrace": true,
  "ChatHistoryConfig": {
    "StorageType": "RDS",
    "ConnectionName": "rdsconnection"
  },
  "ContentModerationConfig": {
    "EnableInputModeration": true,
    "EnableOutputModeration": true,
    "StreamingModerationThreshold": 5
  },
  "DeploymentConfig": "{\\\"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\\\"}}}",
  "DeploymentStages": [
    {
      "Stage": 1,
      "StageName": "PrepareSnapshot",
      "Description": "Create snapshot for deployment",
      "GmtStartTime": "2025-09-23T10:25:38+08:00",
      "GmtEndTime": "2025-09-23T10:35:38+08:00",
      "StageStatus": "Running",
      "ErrorMessage": "This is error",
      "StageInfo": "{\\\"SnapshotId\\\":\\\"snap-i8j29kw8nubqb0hotn\\\"}"
    }
  ],
  "ErrorMessage": "This is error message",
  "AutoApproval": true
}

错误码

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

变更历史

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

上一篇：CreateDeployment - 创建部署任务下一篇：UpdateDeployment - 更新部署任务