Determines whether to start processing the next batch.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
PipelineId String Query Yes e2e-vds-feh-***

The ID of the batch.

Confirm Boolean Query Yes true

Specifies whether to start processing the next batch. Valid values:

  • true: starts processing the next batch.
  • false: terminates the process.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The ID of the request.

Message String success

The returned message.

TraceId String 0a98a02315955564772843261e****

The ID of the trace. It is used to query the details of a request.

Data Object

The batch information.

PipelineId String e2e-vds-feh-***

The ID of the batch.

ErrorCode String This parameter is left empty.

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code String 200

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
Success Boolean true

Indicates whether the processing of the next batch started as required. Valid values:

  • true: The processing started.
  • false: The processing could not start.

Examples

Sample requests

GET /pop/v1/sam/changeorder/ConfirmPipelineBatch?PipelineId=e2e-vds-feh-***&Confirm=true HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ConfirmPipelineBatchResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <PipelineId>e2e-vds-feh-***</PipelineId>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</ConfirmPipelineBatchResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "PipelineId" : "e2e-vds-feh-***"
  },
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter.NotEmpty You must specify the parameter %s. The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty.
400 System.Upgrading The system is being upgraded. Please try again later. The error message returned because the system is being upgraded. Try again later.
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s The error message returned because the value of the %s parameter is invalid: %s.
400 Pipeline.Can.Not.Start.Next.Batch You cannot start the next batch under the current status. The error message returned because the next batch could not be processed when the change order is in the current state.

For a list of error codes, visit the API Error Center.