Use DescribeImportOASTask to query the result of an OAS API import task - API Gateway - Alibaba Cloud - API Gateway

Queries the result of an OAS API import 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:DescribeImportOASTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationId	string	Yes	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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CE5722A6-AE78-4741-A9B0-6C817D360510
ApiResults	object
ApiResult	array<object>	The execution status of the subtask. Valid values: RUNNING WAIT OVER FAIL CANCEL
	object
ApiId	string	The API ID.	c5a0c2900ff746b789c007545be22fb8
Path	string	The request path of the API.	/creator/getByCreatorId
Method	string	The HTTP request HTTP method of the API.	GET
Description	string	The API description.	ThisAPIUsed to query
GroupId	string	The API group ID.	736508d885074167ba8fbce3bc95ea0b
ApiName	string	The API name.	GetByCreatorIdUsingGET
ErrorMessage	string	The cause of the failure if the API fails to be imported.	Internal Error
UpdateStatus	string	The execution status of the subtask. Valid values: RUNNING WAIT OVER FAIL CANCEL	WAIT
ModelResults	object
ModelResult	array<object>	The execution status of the subtask. Valid values: RUNNING WAIT OVER FAIL CANCEL
	object
ModelName	string	The model name.	Pet
ModelId	string	The ID of the imported model.	6b48d724c921415486e190c494dd6bf8
GroupId	string	The API group ID.	736508d885074167ba8fbce3bc95ea0b
ErrorMessage	string	The cause of the failure if the model fails to be imported.	Internal Error
UpdateStatus	string	The execution status of the subtask. Valid values: RUNNING WAIT OVER FAIL CANCEL	FAIL
TaskStatus	string	The status of the import task. Valid values: Running Finished	Finished

Examples

Success response

JSON format

{
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510",
  "ApiResults": {
    "ApiResult": [
      {
        "ApiId": "c5a0c2900ff746b789c007545be22fb8",
        "Path": "/creator/getByCreatorId",
        "Method": "GET",
        "Description": "ThisAPIUsed to query",
        "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.