Control Phased Rollout by Calling ConfirmPipelineBatch - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:ConfirmPipelineBatch

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	Yes	The pipeline ID. To obtain the ID, call the DescribeChangeOrder operation.	e2e-vds-feh-***
Confirm	boolean	Yes	Specifies whether to start the next batch. Valid values: true: Start the next batch. false: Terminate the process.	true

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message.	success
TraceId	string	The trace ID. You can use this ID to look up the details of the call.	0a98a02315955564772843261e****
Data	object	The pipeline information.
PipelineId	string	The pipeline ID.	e2e-vds-feh-***
ErrorCode	string	The error code. The ErrorCode field is not returned if the request is successful. The ErrorCode field is returned if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code for the request. 2xx: The request was successful. 3xx: The request was redirected. 4xx: A request error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the batch confirmation was successful. true: The confirmation was successful. false: The confirmation failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	System.Upgrading	The system is being upgraded. Please try again later.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	Pipeline.Can.Not.Start.Next.Batch	You cannot start the next batch under the current status.	You can not start next batch in current.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.