API Gateway:DescribeDeployApiTask - API Gateway

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationUid	string	Yes	The task ID.	51524fb8f12846d694d0a1de9a0cf274

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CA4B3261-F14A-5E33-8608-F75A1DF27AD4
DeployedResults	object
DeployedResult	array<object>	The returned result.
	object	The returned result.
ErrorMsg	string	The error message.	Success. Request Success.
StageName	string	The runtime environment of the API. Valid values: RELEASE TEST	RELEASE
GroupId	string	The ID of the API group.	e8da6f6346184da9a30d0dc1888b1f3b
ApiUid	string	The ID of the API.	0433c1cd84724923b7a4f9ca1cfc249c
DeployedStatus	string	The deployment status of the API.	OVER

Examples

Success response

JSON format

{
  "RequestId": "CA4B3261-F14A-5E33-8608-F75A1DF27AD4",
  "DeployedResults": {
    "DeployedResult": [
      {
        "ErrorMsg": "Success. Request Success.",
        "StageName": "RELEASE",
        "GroupId": "e8da6f6346184da9a30d0dc1888b1f3b",
        "ApiUid": "0433c1cd84724923b7a4f9ca1cfc249c",
        "DeployedStatus": "OVER"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.