All Products
Search

This Product

    Serverless App Engine:DescribeChangeOrder

    Document Center

    Serverless App Engine:DescribeChangeOrder

    Last Updated:Mar 17, 2026

    The DescribeChangeOrder API queries change order information.

    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

    Change order ID. Obtain by calling the ListChangeOrders API.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    Returned data.

    RequestId

    string

    Request ID.

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

    string

    Additional information about the call result.

    success
    TraceId

    string

    Call chain ID, used for term query of call information.

    0a98a02315955564772843261e****
    Data

    object

    Change order information.

    Status

    integer

    Batch status. Values are as follows:

    • 0: Ready.

    • 1: In progress.

    • 2: Successful.

    • 3: Failed.

    • 6: Terminated.

    • 8: Waiting for manual batch confirmation.

    • 9: Waiting for automatic batch confirmation.

    • 10: System error, execution failed.

    • 11: Waiting for approval.

    • 12: Approved, waiting for execution.

    2
    SubStatus

    integer

    Deployment sub-status. Use this to determine if an exception occurred during deployment. Values are as follows:

    • 0: Normal deployment.

    • 1: Abnormal deployment. For example, an error occurred during phased release. You must manually rollback. In this case, the deployment order is erroneous but remains in progress because it cannot be completed.

    0
    ApprovalId

    string

    Operation approval ID.

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

    string

    Error message.

    success
    BatchWaitTime

    integer

    Wait time before starting the next batch in automatic batch mode. Unit: minutes.

    0
    CreateTime

    string

    Creation time.

    2020-12-17 21:06:45
    BatchCount

    integer

    Number of batches.

    1
    CoTypeCode

    string

    Change type code. Values are as follows:

    • CoBindSlb: Attach SLB.

    • CoUnbindSlb: Detach SLB.

    • CoCreateApp: Create application.

    • CoDeleteApp: Delete application.

    • CoDeploy: Deploy application.

    • CoRestartApplication: Restart application.

    • CoRollback: Rollback application.

    • CoScaleIn: Scale-in application.

    • CoScaleOut: Scale-out application.

    • CoStart: Start application.

    • CoStop: Stop application.

    • CoRescaleApplicationVertically: Modify instance type.

    • CoDeployHistroy: Rollback to historical version.

    • CoBindNas: Attach NAS.

    • CoUnbindNas: Detach NAS.

    • CoBatchStartApplication: Batch start applications.

    • CoBatchStopApplication: Batch stop applications.

    • CoRestartInstances: Restart instances.

    • CoDeleteInstances: Delete instances.

    • CoScaleInAppWithInstances: Scale-in specified instances.

    CoRestartInstances
    SupportRollback

    boolean

    Whether rollback is supported. Values are as follows:

    • true: Rollback is supported.

    • false: Rollback is not supported.

    false
    ChangeOrderId

    string

    Change order ID.

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

    string

    Application name.

    app-test
    BatchType

    string

    Batch type. Values are as follows:

    • auto: Automatic.

    • manual: Manual.

    auto
    Description

    string

    Change order description.

    description
    CoType

    string

    Change type, a description of CoTypeCode.

    批量重启实例
    Auto

    boolean

    Whether it is an automatic batch. Values are as follows:

    • true: Automatic batch change.

    • false: Not an automatic batch change.

    true
    CurrentPipelineId

    string

    Current batch ID.

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

    array<object>

    Batch information.

    object

    Batch information.

    Status

    integer

    Batch status. Values are as follows:

    • 0: Ready.

    • 1: In progress.

    • 2: Successful.

    • 3: Failed.

    • 6: Terminated.

    • 8: Waiting for manual batch confirmation.

    • 9: Waiting for automatic batch confirmation.

    • 10: System error, execution failed.

    • 11: Waiting for approval.

    • 12: Approved, waiting for execution.

    2
    StartTime

    integer

    Start time.

    1562831689704
    UpdateTime

    integer

    Last update time.

    1562847178007
    BatchType

    integer

    Batch type.

    0
    ParallelCount

    integer

    Number of parallel tasks within the batch.

    0
    PipelineName

    string

    Batch name.

    Batch 1 Change
    PipelineId

    string

    Batch ID.

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

    string

    Application ID.

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

    string

    ApplicationEnableGreyTagRoute

    boolean

    ErrorCode

    string

    Error code. Values are as follows:

    • Successful request: The ErrorCode field is not returned.

    • Failed request: The ErrorCode field is returned. For details, see the Error Codes list in this topic.

    空
    Code

    string

    API status or POP error code. Values are as follows:

    • 2xx: Success.

    • 3xx: Redirection.

    • 4xx: Request error.

    • 5xx: Server error.

    200
    Success

    boolean

    Whether change order information was queried successfully. Values are as follows:

    • true: Query successful.

    • false: Query 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": "批量重启实例",
    "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.