API网关 APIG-获取异步任务结果:响应参数

时间:2024-04-09 20:49:30

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

task_id

String

任务id

task_status

String

任务状态。waiting等待处理,processing处理中,succeed成功,failed失败。

枚举值:

  • waiting

  • processing

  • succeed

  • failed

task_type

String

任务类型。 import_api为异步导入api,export_api为异步导出api。

枚举值:

  • import_api

  • export_api

task_result

String

任务结果。string可转成json object。 当task_type为import_api时,字段包括API分组编号group_id、success数组、failure数组、swagger结构体、ignore数组。其中success数组元素中包括4个字段,导入成功的API编号id、API请求方法method、API请求路径path、导入行为action(枚举值,update表示更新API,create表示新建API)。failure数组元素中包括4个字段,API请求方法method、API请求路径path、导入失败的错误码error_code、导入失败的错误信息error_msg。swagger结构体包括2个字段,swagger文档编号id、导入结果说明result。ignore数组元素包括API请求方法method、API请求路径path。 当task_type为export_api时,字段包括导出文件类型file_type、导出文件内容content。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-apig/ShowAsyncTaskResult.html