使用DescribePipeline查询批次信息-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

查看批次信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sae:DescribePipeline

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/changeorder/DescribePipeline HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
PipelineId	string	是	批次 ID。通过调用 DescribeChangeOrder 接口获取。	917660ba-5092-44ca-b8e0-80012c96****

返回参数

名称	类型	描述	示例值
	object	批次信息响应体。
RequestId	string	请求 ID。	559B4247-C41C-4D9E-B866-B55D360B****
Message	string	调用结果的附加信息。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0be3e0c316390414649128666e****
Data	object	批次信息。
ShowBatch	boolean	是否可以开始下一批次执行。取值说明如下： false：不可以开始下一批次执行。 true：可以开始下一批次执行。	false
PipelineStatus	integer	批次状态，取值说明如下： 0：准备就绪。 1：执行中。 2：执行成功。 3：执行失败。 6：中止。 10：系统异常执行失败。	2
CurrentStageId	string	该批次正在执行的阶段 ID。	c3a55592-4c30-4d84-ac2d-e98c18ec****
PipelineName	string	批次名称。	First batch
StageList	array<object>	批次的阶段信息列表。
	array<object>	阶段信息列表的结构体。
Status	integer	阶段的状态，取值说明如下： 0：准备就绪。 1：执行中。 2：执行成功。 3：执行失败。 6：中止。	2
StageId	string	阶段 ID。	c3a55592-4c30-4d84-ac2d-e98c18ec****
ExecutorType	integer	阶段类型，取值说明如下： 0：串行。 1：并行。	0
TaskList	array<object>	状态信息列表。
	object	状态信息列表结构体。
Status	integer	任务的状态，取值说明如下： 0：准备就绪。 1：执行中。 2：执行成功。 3：执行失败。 5：等待重试。 6：中止。	2
StageId	string	阶段 ID。	c3a55592-4c30-4d84-ac2d-e98c18ec****
ErrorMessage	string	任务执行的报错信息。如果任务执行成功，则不会返回该信息。	EDAS-10022
ErrorCode	string	任务执行失败的错误码。如果任务执行成功，则不会返回该信息。	EDAS-10022
TaskName	string	任务名称。	Environment initialization
ErrorIgnore	integer	是否支持失败后执行后面任务，取值说明如下： 0：不支持。 1：支持。	0
Message	string	任务执行信息。	init Namespace success
ShowManualIgnore	boolean	是否支持手动跳过正在执行的任务，取值说明如下： true：支持。 false：不支持。	false
TaskId	string	任务 ID。	bef0122f-de9a-4ab0-8223-b88bf8ad****
StageName	string	阶段的名称。	Application Deployment
NextPipelineId	string	下一批次 ID。	b77b1c98-5772-4f05-95fc-c7bee5fa****
PipelineId	string	批次 ID。	917660ba-5092-44ca-b8e0-80012c96****
CoStatus	string	该批次所在的变更单的状态。	Executed successfully
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	查询批次信息是否成功。取值说明如下： true：查询成功。 false：查询失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "First batch",
    "StageList": [
      {
        "Status": 2,
        "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
        "ExecutorType": 0,
        "TaskList": [
          {
            "Status": 2,
            "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
            "ErrorMessage": "EDAS-10022 ",
            "ErrorCode": "EDAS-10022",
            "TaskName": "Environment initialization",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Application Deployment"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Executed successfully"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.NoPermission	Resource no permission	请求资源无权限

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

变更历史

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