ListDeployments - 获取部署任务列表-人工智能平台 PAI(PAI)-阿里云帮助中心

获取部署任务列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
pailangstudio:ListDeployments	list	全部资源 ``	无	无

请求语法

GET /api/v1/langstudio/deployments HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	否	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	478***
NextToken	string	否	分页游标。用于请求下一页检索的结果。首次请求时置空。后续请求时传入上一次响应返回的 NextToken 值。	10
MaxResults	integer	否	本次请求允许返回的最大记录条数。	20
SortBy	string	否	分页查询时的排序字段，默认使用 GmtCreateTime。取值如下。 GmtCreateTime（默认值）：按创建时间。 GmtModifiedTime：按修改时间。	GmtCreateTime
Order	string	否	排序方式。 ASC：升序。 DESC：降序。	DESC
DeploymentId	string	否	部署任务 ID。	dploy-asdf******1234
ResourceType	string	否	待部署的资源类型。取值： Flow: 工作流的项目 Code: 代码模式的项目	Flow
ResourceId	string	否	待部署的资源 ID。	flow-asdf******123
PageNumber	integer	否	分页查询时，当前页面的页码。	1
PageSize	integer	否	每页所显示的项数，默认为 10	10
Creator	string	否	创建者 ID。	2680******4103
ResourceSnapshotId	string	否	待部署资源的快照 ID。若提供该参数，系统将直接基于该快照进行部署；若未提供，系统会先为资源创建新快照，再执行部署。	snap-asfg******123
ServiceName	string	否	服务名称。支持按服务名称模糊搜索。	myservice01
DeploymentStatus	string	否	部署任务状态。同时查询多个状态以逗号分隔。	Creating,Running
OperationType	string	否	操作类型。取值： Create：新建服务。 Update：更新已有服务。	Create

返回参数

名称	类型	描述	示例值
	object	返回结果。
Deployments	array	部署任务列表。
Deployment	Deployment	部署任务详情。
MaxResults	integer	本次请求允许返回的最大记录条数。	10
NextToken	string	下次请求分页游标。	10
TotalCount	integer	总数量。	100
RequestId	string	请求 ID。	963BD7F9-0C02-5594-9550-BCC6DD43E3C0

示例

正常返回示例

JSON格式

{
  "Deployments": [
    {
      "WorkspaceId": "478***",
      "Accessibility": "PRIVATE",
      "Creator": "2680******4103",
      "GmtCreateTime": "2025-09-24T07:33:53Z",
      "GmtModifiedTime": "2025-09-24T08:58:35Z",
      "DeploymentId": "dploy-asdf******1234",
      "DeploymentStatus": "Running",
      "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": "myconnection"
      },
      "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:38Z",
          "GmtEndTime": "2025-09-19T10:34:01Z",
          "StageStatus": "Running",
          "ErrorMessage": "This is error",
          "StageInfo": "{\\\"SnapshotId\\\":\\\"snap-i8j29k******b0hotn\\\"}"
        }
      ],
      "ErrorMessage": "This is error message",
      "AutoApproval": true
    }
  ],
  "MaxResults": 10,
  "NextToken": 10,
  "TotalCount": 100,
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

错误码

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

变更历史

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