All Products
Search
Document Center

API Gateway:DescribeDeployApiTask

Last Updated:Jul 31, 2025

Queries the progress of an asynchronous API publishing task.

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
apigateway:DescribeDeployApiTaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OperationUidstringYes

The task ID.

51524fb8f12846d694d0a1de9a0cf274

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CA4B3261-F14A-5E33-8608-F75A1DF27AD4
DeployedResultsarray<object>

The returned result.

DeployedResultobject

The returned result.

ErrorMsgstring

The error message.

Success. Request Success.
StageNamestring

The runtime environment of the API. Valid values:

  • RELEASE
  • TEST
RELEASE
GroupIdstring

The ID of the API group.

e8da6f6346184da9a30d0dc1888b1f3b
ApiUidstring

The ID of the API.

0433c1cd84724923b7a4f9ca1cfc249c
DeployedStatusstring

The deployment status of the API.

OVER

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details