All Products
Search
Document Center

API Gateway:DescribeImportOASTask

Last Updated:Jul 31, 2025

Queries the result of an OAS API import 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:DescribeImportOASTaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OperationIdstringYes

The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status of the API import task.

4c53ccf1d40c489686d1adf5c2644a7f

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CE5722A6-AE78-4741-A9B0-6C817D360510
ApiResultsarray<object>

The execution status of the subtask. Valid values:

  • RUNNING
  • WAIT
  • OVER
  • FAIL
  • CANCEL
ApiResultobject
ApiIdstring

The API ID.

c5a0c2900ff746b789c007545be22fb8
Pathstring

The request path of the API.

/creator/getByCreatorId
Methodstring

The HTTP request HTTP method of the API.

GET
Descriptionstring

The API description.

release data api 411055691505041
GroupIdstring

The API group ID.

736508d885074167ba8fbce3bc95ea0b
ApiNamestring

The API name.

GetByCreatorIdUsingGET
ErrorMessagestring

The cause of the failure if the API fails to be imported.

Internal Error
UpdateStatusstring

The execution status of the subtask. Valid values:

  • RUNNING
  • WAIT
  • OVER
  • FAIL
  • CANCEL
WAIT
ModelResultsarray<object>

The execution status of the subtask. Valid values:

  • RUNNING
  • WAIT
  • OVER
  • FAIL
  • CANCEL
ModelResultobject
ModelNamestring

The model name.

Pet
ModelIdstring

The ID of the imported model.

6b48d724c921415486e190c494dd6bf8
GroupIdstring

The API group ID.

736508d885074167ba8fbce3bc95ea0b
ErrorMessagestring

The cause of the failure if the model fails to be imported.

Internal Error
UpdateStatusstring

The execution status of the subtask. Valid values:

  • RUNNING
  • WAIT
  • OVER
  • FAIL
  • CANCEL
FAIL
TaskStatusstring

The status of the import task. Valid values:

  • Running
  • Finished
Finished

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510",
  "ApiResults": {
    "ApiResult": [
      {
        "ApiId": "c5a0c2900ff746b789c007545be22fb8",
        "Path": "/creator/getByCreatorId",
        "Method": "GET",
        "Description": "release data api 411055691505041",
        "GroupId": "736508d885074167ba8fbce3bc95ea0b",
        "ApiName": "GetByCreatorIdUsingGET",
        "ErrorMessage": "Internal Error",
        "UpdateStatus": "WAIT"
      }
    ]
  },
  "ModelResults": {
    "ModelResult": [
      {
        "ModelName": "Pet",
        "ModelId": "6b48d724c921415486e190c494dd6bf8",
        "GroupId": "736508d885074167ba8fbce3bc95ea0b",
        "ErrorMessage": "Internal Error\n",
        "UpdateStatus": "FAIL"
      }
    ]
  },
  "TaskStatus": "Finished"
}

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