调用DescribeImportOASTask查询OAS导入API的任务_API 网关(API Gateway)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeImportOASTask	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
OperationId	string	是	进行导入操作时生成的异步任务 ID，用来查询导入任务的执行情况	4c53ccf1d40c489686d1adf5c2644a7f

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 id	CE5722A6-AE78-4741-A9B0-6C817D360510
ApiResults	array<object>	API 的导入结果
ApiResult	object
ApiId	string	API 的 ID	c5a0c2900ff746b789c007545be22fb8
Path	string	API 的请求路径	/creator/getByCreatorId
Method	string	API 的请求 HTTP Method	GET
Description	string	API 的描述信息	这个API用于查询
GroupId	string	API 分组 ID	736508d885074167ba8fbce3bc95ea0b
ApiName	string	api 名称	GetByCreatorIdUsingGET
ErrorMessage	string	如果导入失败时，显示失败的原因	Internal Error
UpdateStatus	string	当前子任务执行的状态 RUNNING：执行中 WAIT：等待调度 OVER：执行成功 FAIL：执行失败 CANCEL：取消执行	WAIT
ModelResults	array<object>	模型的导入结果
ModelResult	object
ModelName	string	模型名称	Pet
ModelId	string	导入的模型 id	6b48d724c921415486e190c494dd6bf8
GroupId	string	API 分组 ID	736508d885074167ba8fbce3bc95ea0b
ErrorMessage	string	如果导入失败时，显示失败的原因	Internal Error
UpdateStatus	string	当前子任务执行的状态 RUNNING：执行中 WAIT：等待调度 OVER：执行成功 FAIL：执行失败 CANCEL：取消执行	FAIL
TaskStatus	string	导入任务的执行状态： 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"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史