All Products
Search

This Product

    Serverless App Engine:DescribeChangeOrder

    Document Center

    Serverless App Engine:DescribeChangeOrder

    Last Updated:Dec 17, 2025

    Queries the information of a change order.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    sae:DescribeChangeOrderget
    *All Resources
    *
      none
    		none

    Request syntax

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ChangeOrderIdstringYes

    The ID of the change order. You can call the ListChangeOrders operation to obtain the ID.

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The request ID.

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

    The returned message.

    		success
    TraceIdstring

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

    		0a98a02315955564772843261e****
    Dataobject

    The details of the change order.

    Statusinteger

    The status of the change order. Valid values:

    • 0: The change order is being prepared.
    • 1: The change order is being executed.
    • 2: The change order was executed.
    • 3: The change order failed to be executed.
    • 6: The change order was terminated.
    • 8: The execution process is pending. You must manually release the batches.
    • 9: The execution process is pending. SAE will automatically release the batches.
    • 10: The execution failed due to a system exception.
    • 11: The change order is pending approval.
    • 12: The change order is approved and is pending execution.
    		2
    SubStatusinteger

    The substatus of the change order. This parameter indicates whether an exception occurred while the change order was being executed. Valid values:

    • 0: No exception occurred.
    • 1: An exception occurred. For example, if an error occurs during a phased release, you must manually roll back the application. In this case, the change order cannot be completed, so the Status parameter is still displayed as "1", which indicates that the change order is being executed. You can check the value of this parameter to determine whether an exception occurs.
    		0
    ApprovalIdstring

    The approval ID of the change order.

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

    The error message.

    		success
    BatchWaitTimeinteger

    The interval between batches in a phased release. SAE automatically releases batches at the specified interval. Unit: minutes.

    		0
    CreateTimestring

    The time when the change order was created.

    		2020-12-17 21:06:45
    BatchCountinteger

    The number of release batches.

    		1
    CoTypeCodestring

    The code of the change type. Valid values:

    • CoBindSlb: associates a Sever Load Balancer (SLB) instance with the application.
    • CoUnbindSlb: disassociates the SLB instance from the application.
    • CoCreateApp: creates the application.
    • CoDeleteApp: deletes the application.
    • CoDeploy: deploys the application.
    • CoRestartApplication: restarts the application.
    • CoRollback: rolls back the application.
    • CoScaleIn: scales in the application.
    • CoScaleOut: scales out the application.
    • CoStart: starts the application.
    • CoStop: stops the application.
    • CoRescaleApplicationVertically: modifies the instance type.
    • CoDeployHistroy: rolls back the application to a historical version.
    • CoBindNas: associates a NAS file system with the application.
    • CoUnbindNas: disassociates the NAS file system from the application.
    • CoBatchStartApplication: starts multiple applications concurrently.
    • CoBatchStopApplication: stops multiple applications concurrently.
    • CoRestartInstances: restarts the instances.
    • CoDeleteInstances: deletes the instances.
    • CoScaleInAppWithInstances: reduces the specified number of application instances.
    		CoRestartInstances
    SupportRollbackboolean

    Indicates whether the application can be rolled back. Valid values:

    • true: The application can be rolled back.
    • false: The application cannot be rolled back.
    		false
    ChangeOrderIdstring

    The ID of the change order.

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

    The name of the application.

    		app-test
    BatchTypestring

    The processing method for the batches. Valid values:

    • auto: SAE automatically releases the batches.
    • Manual: You must manually release the batches.
    		auto
    Descriptionstring

    The description of the change order.

    		description
    CoTypestring

    The change type, which corresponds to the CoTypeCode parameter.

    Autoboolean

    Indicates whether SAE automatically releases the batches. Valid values:

    • true: SAE automatically releases the batches.
    • false: SAE does not automatically release the batches.
    		true
    CurrentPipelineIdstring

    The ID of the current batch.

    		0e4acf82-c9b1-4c1e-ac28-55776338****
    Pipelinesarray<object>

    The batch information.

    Pipelineobject
    Statusinteger

    The status of the batch. Valid values:

    • 0: The batch is being prepared.
    • 1: The batch is being processed.
    • 2: The batch was processed.
    • 3: The batch failed to be processed.
    • 6: The batch processing was terminated.
    • 8: The execution process is pending. You must manually release the batch.
    • 9: The execution process is pending. SAE will automatically release the batch.
    • 10: The batch failed to be processed due to a system exception.
    • 11: The batch is pending approval.
    • 12: The batch is approved and is pending execution.
    		2
    StartTimelong

    The time when the batch processing started.

    		1562831689704
    UpdateTimelong

    The time when the batch information was last modified.

    		1562847178007
    BatchTypeinteger

    The batch type.

    		0
    ParallelCountinteger

    The number of parallel tasks in a batch.

    		0
    PipelineNamestring

    The name of the batch.

    		Batch 1 Change
    PipelineIdstring

    The ID of the batch.

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

    The ID of the application.

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

    The error code. Valid values:

    • If the call is successful, the ErrorCode parameter is not returned.
    • If the call fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
    Codestring

    The HTTP status code. Valid values:

    • 2xx: The call was successful.
    • 3xx: The call was redirected.
    • 4xx: The call failed.
    • 5xx: A server error occurred.
    		200
    Successboolean

    Indicates whether the information of the change order was queried. Valid values:

    • true: The information was queried.
    • false: The information failed to be queried.
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "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": true
  },
  "ErrorCode": "",
  "Code": 200,
  "Success": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameter.NotEmptyYou must specify the parameter %s.-
    400Resouce.no.permissionYou are not authorized to operate on the specified resources.You are not authorized to operate on the specified resources.
    400InvalidChangeOrder.NotFoundThe current change order does not exist.The current change order does not exist.
    404InvalidAppId.NotFoundThe specified AppId does not exist.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2025-05-13The Error code has changed. The response structure of the API has changedView Change Details