DescribeUpdateBackendTask - API Gateway - Alibaba Cloud Documentation Center

When you modify the definition of a backend service in an environment, the associated published APIs are updated in batches. You can call this operation to query the results of the update.

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

apigateway:DescribeUpdateBackendTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationUid	string	Yes	The task ID.	4e13c3e0c44c4a4ebb5231264eeb9bc1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ016
ApiUpdateBackendResults	object
ApiUpdateBackendResult	array<object>	The update results for the APIs.
	object	The update result for an API.
StageId	string	The ID of the environment.	d8f2f54f3309458b8aaceb36c01c2dd9
UpdateStatus	string	The update status of the API.	OVER
GroupName	string	The group name.	imotob1
GroupId	string	The group ID.	3013a55c0c44483f984d26df27120513
ApiUid	string	The API ID.	14faa7ba0572445685866ddb6a6f19da
ErrorMsg	string	The error message returned if the update failed.	Failed
StageName	string	The environment name.	RELEASE
ApiName	string	The API name.	checkin_linechart_today
BackendId	string	The backend service ID.	c09b078bcb8f4ade9677bd8b18cdf43f

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ016",
  "ApiUpdateBackendResults": {
    "ApiUpdateBackendResult": [
      {
        "StageId": "d8f2f54f3309458b8aaceb36c01c2dd9",
        "UpdateStatus": "OVER",
        "GroupName": "imotob1",
        "GroupId": "3013a55c0c44483f984d26df27120513",
        "ApiUid": "14faa7ba0572445685866ddb6a6f19da",
        "ErrorMsg": "Failed",
        "StageName": "RELEASE",
        "ApiName": "checkin_linechart_today",
        "BackendId": "c09b078bcb8f4ade9677bd8b18cdf43f"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.