All Products
Search

This Product

    Serverless App Engine:DescribeChangeOrder

    Document Center

    Serverless App Engine:DescribeChangeOrder

    Last Updated:Apr 22, 2026

    Call DescribeChangeOrder to get information about a change order.

    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:DescribeChangeOrder

    get

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ChangeOrderId

    string

    Yes

    The change order ID. You can obtain it by calling the ListChangeOrders interface.

    76fa5c0-9ebb-4bb4-b383-1f885447****

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    The message returned for the request.

    success
    TraceId

    string

    The trace ID of the request. This ID is used for troubleshooting.

    0a98a02315955564772843261e****
    Data

    object

    The details of the change order.

    Status

    integer

    The status of the change order. Valid values:

    • 0: Preparing

    • 1: In progress

    • 2: Succeeded

    • 3: Failed

    • 6: Terminated

    • 8: Awaiting manual confirmation

    • 9: Awaiting automatic confirmation

    • 10: Failed due to a system error

    • 11: Pending approval

    • 12: Approved and pending execution

    2
    SubStatus

    integer

    The substatus of the release order. This parameter indicates whether an exception occurred during the release. Valid values:

    • 0: Normal.

    • 1: Abnormal. For example, if a batch release fails, you must manually perform a rollback, leaving the release order in the In Progress state.

    0
    ApprovalId

    string

    The approval ID for the operation.

    67de0b39-a9d4-4c09-a170-cf438208****
    ErrorMessage

    string

    The error message.

    success
    BatchWaitTime

    integer

    The wait time, in minutes, between batches in an automatic release.

    0
    CreateTime

    string

    The time when the change order was created.

    2020-12-17 21:06:45
    BatchCount

    integer

    The number of batches.

    1
    CoTypeCode

    string

    The change type code. Valid values:

    • CoBindSlb: Binds an SLB instance.

    • CoUnbindSlb: Unbinds an SLB instance.

    • CoCreateApp: Creates an application.

    • CoDeleteApp: Deletes an application.

    • CoDeploy: Deploys an application.

    • CoRestartApplication: Restarts an application.

    • CoRollback: Rolls back an application.

    • CoScaleIn: Scales in an application.

    • CoScaleOut: Scales out an application.

    • CoStart: Starts an application.

    • CoStop: Stops an application.

    • CoRescaleApplicationVertically: Modifies instance specifications.

    • CoDeployHistroy: Rolls back to a historical version.

    • CoBindNas: Binds a NAS file system.

    • CoUnbindNas: Unbinds a NAS file system.

    • CoBatchStartApplication: Starts applications in batches.

    • CoBatchStopApplication: Stops applications in batches.

    • CoRestartInstances: Restarts instances.

    • CoDeleteInstances: Deletes instances.

    • CoScaleInAppWithInstances: Scales in an application by specifying instances.

    CoRestartInstances
    SupportRollback

    boolean

    Indicates whether rollback is supported. Valid values:

    • true: Rollback is supported.

    • false: Rollback is not supported.

    false
    ChangeOrderId

    string

    The change order ID.

    765fa5c0-9ebb-4bb4-b383-1f885447**
    AppName

    string

    The application name.

    app-test
    BatchType

    string

    The release mode for batches. Valid values:

    • auto: Automatic release.

    • manual: Manual release.

    auto
    Description

    string

    The description of the change order.

    description
    CoType

    string

    The change type. This parameter is a description of CoTypeCode.

    Batch Restart Instances
    Auto

    boolean

    Indicates whether to automatically release the change in batches. Valid values:

    • true: The change is automatically released.

    • false: The change is not automatically released.

    true
    CurrentPipelineId

    string

    The ID of the current batch.

    0e4acf82-c9b1-4c1e-ac28-55776338****
    Pipelines

    array<object>

    The batch information.

    object

    The information about a batch.

    Status

    integer

    The status of the batch. Valid values:

    • 0: Preparing

    • 1: In progress

    • 2: Succeeded

    • 3: Failed

    • 6: Terminated

    • 8: Awaiting manual confirmation

    • 9: Awaiting automatic confirmation

    • 10: Failed due to a system error

    • 11: Pending approval

    • 12: Approved and pending execution

    2
    StartTime

    integer

    The start time of the batch.

    1562831689704
    UpdateTime

    integer

    The time when the batch was last updated.

    1562847178007
    BatchType

    integer

    The batch type.

    0
    ParallelCount

    integer

    The number of parallel tasks in a batch.

    0
    PipelineName

    string

    The batch name.

    Batch 1 Change
    PipelineId

    string

    The batch ID.

    0e4acf82-c9b1-4c1e-ac28-55776338****
    AppId

    string

    The application ID.

    bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
    ApplicationUpdateStrategy

    string

    The update strategy for the application.

    ApplicationEnableGreyTagRoute

    boolean

    Indicates whether gray tag routing is enabled.

    ErrorCode

    string

    The error code.

    • If the request is successful, this parameter is not returned.

    • If the request fails, this parameter is returned. For more information, see the error codes section of this topic.

    Code

    string

    The HTTP status code or POP error code. Valid values:

    • 2xx: The request was successful.

    • 3xx: The request was redirected.

    • 4xx: A client-side error occurred.

    • 5xx: A server-side error occurred.

    200
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": false
  },
  "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 Resouce.no.permission You are not authorized to operate on the specified resources. You are not authorized to operate on the specified resources.
    400 InvalidChangeOrder.NotFound The current change order does not exist. The current change order does not exist.
    404 InvalidAppId.NotFound The specified AppId does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.