GetDeployment - 获取部署任务详情

更新时间:
复制为 MD 格式

获取部署任务详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pailangstudio:GetDeploymentget
*全部资源
*

请求语法

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

请求参数

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

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

478***
DeploymentIdstring

部署任务 ID。

dploy-asdf******1234

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID

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

工作空间 ID。

478***
Accessibilitystring

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

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

创建者 ID。

2003******4844
GmtCreateTimestring

创建时间。

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

修改时间。

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

部署任务 ID。

dploy-asdf******1234
DeploymentStatusstring

部署任务状态。取值:

  • Creating:创建中。
  • Failed:部署失败。
  • Stopping:停止中。
  • Waiting:等待中。
  • Starting:启动中。
  • Running:运行中。
  • Pending:等待中。
  • WaitForConfirm: 等待确认。
  • Canceled:取消。
  • Succeed:成功。
Succeed
OperationTypestring

操作类型。取值:

  • Create: 新建服务。
  • Update: 更新已有服务。
Create
ResourceTypestring

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

  • Flow: 工作流的项目
  • Code: 代码模式的项目
Flow
ResourceIdstring

待部署的资源 ID。

flow-asdf******123
ResourceSnapshotIdstring

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

snap-asfg******123
ServiceNamestring

服务名字。格式要求:

  • 支持小写字母、数字和下划线
  • 必须以字母开头
  • 长度 1-45 个字符
myservice01
Descriptionstring

服务描述。

This is description
WorkDirstring

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

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

是否启用链路追踪。

true
ChatHistoryConfigobject

对话历史配置。

StorageTypestring

存储方式。取值:

  • LOCAL: 对话历史保存在本地 SQLite 文件,不支持多实例的部署方式。
  • OSS:对话历史保存在服务 OSS 工作路径下特定的路径下。
  • RDS:对话历史保存在 RDS 的表中,需要指定一个 RDS 连接。
RDS
ConnectionNamestring

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

rdsconnection
ContentModerationConfigobject

内容审核配置。

EnableInputModerationboolean

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

true
EnableOutputModerationboolean

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

true
StreamingModerationThresholdinteger

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

5
DeploymentConfigstring

部署配置。具体参考 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\"}}}
DeploymentStagesarray<object>

部署的阶段信息。

DeploymentStageobject
Stageinteger

部署阶段。

1
StageNamestring

部署阶段名称。

PrepareSnapshot
Descriptionstring

部署阶段描述。

Create snapshot for deployment
GmtStartTimestring

开始时间。

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

结束时间。

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

部署阶段状态。取值:

  • NotStarted: 未开始。
  • WaitForConfirm:等待确认。
  • Waiting: 等待中。
  • Creating: 创建中。
  • Running: 运行中。
  • Succeed: 成功。
  • Failed: 失败。
  • Canceled:取消。
Running
ErrorMessagestring

错误信息。

This is error
StageInfostring

部署阶段信息。

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

错误信息。

This is error message
AutoApprovalboolean

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

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
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-03-12新增 OpenAPI查看变更详情