请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 server 是 DisassociateEcsServerInfo object 需要绑定密钥对的虚拟机信息。 表4 DisassociateEcsServerInfo 参数 是否必选 参数类型 描述 id 是 String 需要绑定(替换或重置)SSH密钥对的虚拟机id auth 否 Auth object 可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。 表5 Auth 参数 是否必选 参数类型 描述 type 否 String 取值为枚举类型。password或keypair。 key 否 String type为枚举值password时，key表示密码； type为枚举值keypair时，key表示私钥；

请求示例 { "server" : { "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7", "auth" : { "type" : "keypair", "key" : "-----BEGINRSAPRIVATEKEY-----\nM..." } } } { "server" : { "id" : "x76baba7-ef09-40a2-87ff-3eafec0696e7" } }

响应参数 状态码： 202 表6 响应Body参数 参数 参数类型 描述 task_id String 任务下发成功返回的ID。 server_id String 绑定的虚拟机id。 status String 任务下发的状态。SUC CES S或FAILED。 error_code String 任务下发失败返回的错误码。 error_msg String 任务下发失败返回的错误信息。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 操作结果，值固定为success 最小长度：7 最大长度：7 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

响应示例 状态码： 200 响应Body参数 { "job_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433", "status" : "success", "job_type" : "bind_ldap", "begin_time" : "2023-07-26 09:33:58", "end_time" : "2023-07-26 09:33:58" } 状态码： 400 客户端错误 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码： 404 资源不存在 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码： 500 内部错误 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表4 响应Body参数 参数 参数类型 描述 status String job的状态。success：成功。running：运行中。failed：失败。waiting：等待执行 job_id String job的ID。 job_type String job的类型。 begin_time String job开始时间。UTC时间，格式：'2016-01-02 15:04:05' end_time String job结束时间。UTC时间，格式：'2016-01-02 15:04:05' error_code String job执行失败时的错误码 fail_reason String job执行失败时的错误原因 sub_jobs Array of GetSubJobDetail objects 子任务列表 表5 GetSubJobDetail 参数 参数类型 描述 status String 子job的状态。success：成功。running：运行中。failed：失败。waiting：等待执行。 job_id String job的ID。 job_type String 子job的类型。 begin_time String job开始时间。UTC时间，格式：'2016-01-02 15:04:05' end_time String job结束时间。UTC时间，格式：'2016-01-02 15:04:05' error_code String job执行失败时的错误码 fail_reason String job执行失败时的错误原因 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 errMsg String 错误描述

响应示例 状态码： 200 响应Body参数 { "job_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433", "status" : "success", "job_type" : "bind_ldap", "begin_time" : "2023-07-26 09:33:58", "end_time" : "2023-07-26 09:33:58" } 状态码： 400 客户端错误 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码： 404 资源不存在 { "errCode" : "SFS.TURBO.0001", "errMsg" : "parameter error" } 状态码： 500 内部错误 { "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID 表4 响应Body参数 参数 参数类型 描述 status String job的状态。success：成功。running：运行中。failed：失败。waiting：等待执行 枚举值： success failed waiting running job_id String job的ID。 job_type String job的类型。 begin_time String job开始时间。UTC时间，格式：'2016-01-02 15:04:05' end_time String job结束时间。UTC时间，格式：'2016-01-02 15:04:05' error_code String job执行失败时的错误码 fail_reason String job执行失败时的错误原因 sub_jobs Array of GetSubJobDetail objects 子任务列表 表5 GetSubJobDetail 参数 参数类型 描述 status String 子job的状态。success：成功。running：运行中。failed：失败。waiting：等待执行。 job_id String job的ID。 job_type String 子job的类型。 begin_time String job开始时间。UTC时间，格式：'2016-01-02 15:04:05' end_time String job结束时间。UTC时间，格式：'2016-01-02 15:04:05' error_code String job执行失败时的错误码 fail_reason String job执行失败时的错误原因 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errCode String 错误码 最小长度：8 最大长度：36 errMsg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 task_id String 任务id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 202 Accepted { "task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2" } 状态码： 400 Bad Request { "error_code" : "APIG.3603", "error_msg" : "The input data is too long" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 FormData参数 参数 是否必选 参数类型 描述 is_create_group 否 Boolean 是否创建新分组 缺省值：true group_id 否 String API分组编号，当is_create_group=false时为必填 extend_mode 否 String 扩展信息导入模式 merge：当扩展信息定义冲突时，merge保留原有扩展信息 override：当扩展信息定义冲突时，override会覆盖原有扩展信息 缺省值：merge simple_mode 否 Boolean 是否开启简易导入模式 缺省值：false mock_mode 否 Boolean 是否开启Mock后端 缺省值：false api_mode 否 String 导入模式 merge：当API信息定义冲突时，merge保留原有API信息 override：当API信息定义冲突时，override会覆盖原有API信息 缺省值：merge file_name 是 File 导入Api的请求体，json或yaml格式的文件

响应示例 状态码： 200 OK 示例 1 { "task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2", "task_status" : "succeed", "task_type" : "import_api", "task_result" : "{\"success\":[{\"id\":\"ee93ce6815f04896b301452982b92222\",\"action\":\"create\",\"method\":\"GET\",\"path\":\"/test1\"}],\"failure\":[],\"swagger\":{\"id\":\"de1852ab6c5e4090b0bd88a02058e650\",\"result\":\"Success\"},\"group_id\":\"9100ae30705947cc9543d37cd7fb388c\"}" } 示例 2 { "task_id" : "d6e8834b6f0f4711a2fa5345e5b60833", "task_status" : "succeed", "task_type" : "export_api", "task_result" : "{\"FileName\":\"test8-RELEASE-all-2023-07-11-19:54:22\",\"FileType\":\".json\",\"Comment\":\"{\\n\\t\\\"swagger\\\": \\\"2.0\\\",\\n\\t\\\"info\\\": {\\n\\t\\t\\\"title\\\": \\\"test8\\\",\\n\\t\\t\\\"version\\\": \\\"2023-07-11-19:54:22\\\"\\n\\t},\\n\\t\\\"host\\\": \\\"9100ae30705947cc9543d37cd7fb388c.apic.cn-north-7.huaweicloudapis.com\\\",\\n\\t\\\"paths\\\": {\\n\\t\\t\\\"/test1\\\": {\\n\\t\\t\\t\\\"get\\\": {\\n\\t\\t\\t\\t\\\"security\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"apig-auth-app\\\": []\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"schemes\\\": [\\n\\t\\t\\t\\t\\t\\\"https\\\"\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"operationId\\\": \\\"API_zjev\\\",\\n\\t\\t\\t\\t\\\"responses\\\": {\\n\\t\\t\\t\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"$ref\\\": \\\"#/responses/default\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-failure-sample\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-normal-sample\\\": \\\"\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-backend\\\": {\\n\\t\\t\\t\\t\\t\\\"mockEndpoints\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"description\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\t\\\"result-content\\\": \\\"not ok\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"type\\\": \\\"MOCK\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-cors\\\": false,\\n\\t\\t\\t\\t\\\"x-apigateway-match-mode\\\": \\\"NORMAL\\\",\\n\\t\\t\\t\\t\\\"x-apigateway-request-type\\\": \\\"public\\\"\\n\\t\\t\\t}\\n\\t\\t}\\n\\t},\\n\\t\\\"responses\\\": {\\n\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\\"description\\\": \\\"response example\\\"\\n\\t\\t}\\n\\t},\\n\\t\\\"securityDefinitions\\\": {\\n\\t\\t\\\"apig-auth-app\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-app-header\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-opt\\\": {\\n\\t\\t\\t\\t\\\"appcode-auth-type\\\": \\\"header\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-iam\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"unused\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"IAM\\\"\\n\\t\\t}\\n\\t}\\n,\\n\\t\\\"x-apigateway-responses\\\": {}\\n}\"}" } 示例 3 { "task_id" : "f01d2772ea4944408fa544c8ae5a9999", "task_status" : "failed", "task_type" : "import_api", "task_result" : "{\"error_code\":\"APIG.3201\",\"error_msg\":\"The API group name already exists\"}" } 示例 4 { "task_id" : "4dfbf6acaacf4c41a8b3c50daa90d3dc", "task_status" : "processing", "task_type" : "import_api", "task_result" : "" } 示例 5 { "task_id" : "c3b78a52fb28461aab92bf6c6989f731", "task_status" : "waiting", "task_type" : "import_api", "task_result" : "" } 状态码： 400 Bad Request { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified,parameterName:task_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3093", "error_msg" : "The asynchronous task d9ce8c9eede54b3f841ec324fe0bfdc2 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

URI GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 task_id 是 String 异步任务ID

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务id task_status String 任务状态。waiting等待处理，processing处理中，succeed成功，failed失败。 task_type String 任务类型。 import_api为异步导入api，export_api为异步导出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 错误描述

响应参数 状态码为200时 表2 响应参数 参数 参数类型 描述 count Integer 符合条件的所有渲染任务的数量。 render_tasks Array of objects 渲染任务信息列表，详情请参见表3。 表3 render_task字段数据结构说明 参数 参数类型 描述 task_id String 任务ID。 连接任务的唯一标识，格式为UUID。 application_id String 应用ID。 应用的唯一标识，格式为UUID。 server_id String 云服务器ID。 云服务器的唯一标识，格式为UUID。 session_id String 会话ID，提供音视频流的会话ID。 普通型云服务器该ID为空。 会话型云服务器该ID为会话编号。 device_id String 设备ID，设备的唯一标识。 device_brand String 设备品牌。 device_type String 设备类型。 application_user String 应用使用用户标识。 application_launch_args String 应用启动参数。 protocol_type String 设备与云服务器进行通信时所使用的协议类型。 location Array of strings 区域列表或边缘小站列表。 resolution String GPU云服务器 传给设备的画面分辨率。 gpu_ip_type String 分配给设备使用的GPU云服务器的IP类型。 status String 任务状态。 status的取值范围如下： active：运行中的任务。 finish：已经结束运行的任务。 start_time String 任务开始时间。 时间格式例如：2020-05-20T03:30:52Z finish_time String 任务结束时间。 时间格式例如：2020-05-20T03:30:52Z finish_reason String 任务结束原因。 finish_reason的取值范围如下： cancel：主动停止任务。 normal：任务正常结束。 error：出现故障，任务结束。 server_deleted：云服务器删除，任务结束。 application_start_failed：启动应用失败，任务结束。 device_changed：修改设备，任务结束。 状态码为400时 表4 响应参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。