Use DescribeAbolishApiTask to query API unpublishing task progress - API Gateway

Queries the progress of an API unpublishing task.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationUid	string	Yes	The ID of the unpublishing operation.	fc54**dd4c4ad7edd7***39401

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99
ApiAbolishResults	object
ApiAbolishResult	array<object>	The result returned.
	object	The result returned.
StageId	string	The ID of the runtime environment.	0919f2854a88484c91dc9253347c78f9
AbolishStatus	string	The unpublishing status.	OVER
GroupId	string	The ID of the API group.	160cb6505e1c43a6b84346856d74eb47
GroupName	string	The name of the API group.	wb2022021401619286
ApiUid	string	The ID of the API.	4e26cdbbb113416dba1f0285bed29979
ErrorMsg	string	The error message.	Success. Request Success.
StageName	string	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
ApiName	string	The name of the API.	v2_page_consent

Examples

Success response

JSON format

{
  "RequestId": "E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99",
  "ApiAbolishResults": {
    "ApiAbolishResult": [
      {
        "StageId": "0919f2854a88484c91dc9253347c78f9",
        "AbolishStatus": "OVER",
        "GroupId": "160cb6505e1c43a6b84346856d74eb47",
        "GroupName": "wb2022021401619286",
        "ApiUid": "4e26cdbbb113416dba1f0285bed29979",
        "ErrorMsg": "Success. Request Success.",
        "StageName": "RELEASE",
        "ApiName": "v2_page_consent"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.