首页 API 网关 开发指南 API参考指南 API目录 API管理 DescribeImportOASTask - 查询OAS导入API的任务

DescribeImportOASTask - 查询OAS导入API的任务

查询OAS批量导入API的结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
OperationIdstring

进行导入操作时生成的异步任务ID,用来查询导入任务的执行情况

4c53ccf1d40c489686d1adf5c2644a7f

返回参数

名称类型描述示例值
object
RequestIdstring

请求id

CE5722A6-AE78-4741-A9B0-6C817D360510
ApiResultsarray

API的导入结果

object
ApiIdstring

API的ID

c5a0c2900ff746b789c007545be22fb8
Pathstring

API的请求路径

/creator/getByCreatorId
Methodstring

API的请求HTTP Method

GET
Descriptionstring

API的描述信息

这个API用于查询
GroupIdstring

API分组 ID

736508d885074167ba8fbce3bc95ea0b
ApiNamestring

api名称

GetByCreatorIdUsingGET
ErrorMessagestring

如果导入失败时,显示失败的原因

Internal Error
UpdateStatusstring

当前子任务执行的状态

  • RUNNING:执行中
  • WAIT:等待调度
  • OVER:执行成功
  • FAIL:执行失败
  • CANCEL:取消执行
WAIT
ModelResultsarray

模型的导入结果

object
ModelNamestring

模型名称

Pet
ModelIdstring

导入的模型id

6b48d724c921415486e190c494dd6bf8
GroupIdstring

API分组ID

736508d885074167ba8fbce3bc95ea0b
ErrorMessagestring

如果导入失败时,显示失败的原因

Internal Error
UpdateStatusstring

当前子任务执行的状态

  • RUNNING:执行中
  • WAIT:等待调度
  • OVER:执行成功
  • FAIL:执行失败
  • CANCEL:取消执行
FAIL
TaskStatusstring

导入任务的执行状态:

  • Running:运行中
  • Finished:执行完成
Finished

示例

正常返回示例

JSON格式

{
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510",
  "ApiResults": {
    "ApiResult": [
      {
        "ApiId": "c5a0c2900ff746b789c007545be22fb8",
        "Path": "/creator/getByCreatorId",
        "Method": "GET",
        "Description": "这个API用于查询",
        "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"
}

错误码

访问错误中心查看更多错误码。

阿里云首页 API 网关 相关技术圈