云服务器内容精选

  • 响应示例 状态码: 200 OK { "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2", "failure" : [ { "path" : "/test/demo", "error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo", "method" : "GET", "error_code" : "APIG.3301" } ], "success" : [ { "path" : "/test", "method" : "GET", "action" : "create", "id" : "8ae6bcafab6f49d78242bff26ad8a4f0" } ], "swagger" : { "id" : "e2ea8a7c1cfc49b3830437cb79d7fd59", "result" : "Success" } } 状态码: 400 Bad Request { "error_code" : "APIG.3201", "error_msg" : "The API group name already exists" } 状态码: 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.3001", "error_msg" : "API group not found" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 success Array of Success objects 导入成功信息 failure Array of Failure objects 导入失败信息 swagger Swagger object swagger文档导入结果 暂不支持 group_id String API分组编号 ignore Array of Ignore objects 被忽略导入的API信息 表5 Success 参数 参数类型 描述 path String API请求路径 method String API请求方法 action String 导入行为: update:表示更新API create:表示新建API 枚举值: update create id String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger 参数 参数类型 描述 id String swagger文档编号 result String 导入结果说明 表8 Ignore 参数 参数类型 描述 method String API请求方法 path String API请求路径 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表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 枚举值: merge override simple_mode 否 Boolean 是否开启简易导入模式 缺省值:false mock_mode 否 Boolean 是否开启Mock后端 缺省值:false api_mode 否 String 导入模式 merge:当API信息定义冲突时,merge保留原有API信息 override:当API信息定义冲突时,override会覆盖原有API信息 缺省值:merge 枚举值: merge override file_name 是 File 导入Api的请求体,json或yaml格式的文件
  • 响应示例 状态码: 200 OK { "failure" : [ { "path" : "/test/demo", "error_msg" : "The backend API already exists", "method" : "GET", "error_code" : "APIG.3314" } ], "success" : [ { "path" : "/test", "method" : "GET", "action" : "create", "id" : "8ae6bcafab6f49d78242bff26ad8a4f0" } ], "swagger" : { } } 状态码: 400 Bad Request { "error_code" : "APIG.3201", "error_msg" : "The API group name already exists" } 状态码: 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.3001", "error_msg" : "API group not found" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 success Array of Success objects 导入成功信息 failure Array of Failure objects 导入失败信息 swagger Swagger object swagger文档导入结果 暂不支持 表5 Success 参数 参数类型 描述 path String API请求路径 method String API请求方法 action String 导入行为: update:表示更新API create:表示新建API id String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger 参数 参数类型 描述 id String swagger文档编号 result String 导入结果说明 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 FormData参数 参数 是否必选 参数类型 描述 extend_mode 否 String 扩展信息导入模式 merge:当扩展信息定义冲突时,merge保留原有扩展信息 override:当扩展信息定义冲突时,override会覆盖原有扩展信息 缺省值:merge api_mode 否 String 导入模式 merge:当API信息定义冲突时,merge保留原有API信息 override:当API信息定义冲突时,override会覆盖原有API信息 缺省值:merge file_name 是 File 导入自定义后端API的请求体,json或yaml格式的文件
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String API所属的应用ID format 否 String 导出的API定义的格式 缺省值:json apis 否 Array of strings 导出的自定义后端API ID列表 status 否 Integer 导出的后端API状态: 1:待开发 3:开发中 4:已部署
  • 响应示例 状态码: 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:instance_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.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 - File OK 状态码: 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 错误描述 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应消息 表4 参数说明 名称 是否必选 参数类型 说明 swagger 是 String 固定值2.0 info 是 Object 参考表5 host 是 String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表10 securityDefinitions 是 Object 定义鉴权方式,参考表14 x-apigateway-access-controls 否 Object 访问控制信息,参考表 x-apigateway-access-controls参数说明 x-apigateway-ratelimits 否 Object 流量空时信息,参考表 x-apigateway-ratelimits参数说明 表5 info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表6 paths参数说明 名称 是否必选 参数类型 说明 uri 是 Object API访问地址,参考表7 表7 uri参数说明 名称 是否必选 参数类型 说明 method 是 Object API访问方法,参考表8 表8 method参数说明 名称 是否必选 参数类型 说明 operationId 是 String API的名称 description 否 String API的描述信息 schemes 是 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses 是 Object 响应定义,参考表10 security 否 Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies 否 Object API的策略后端信息,参考表 x-apigateway-backend-policies参数说明 x-apigateway-cors 否 Boolean 是否支持跨域 x-apigateway-match-mode 否 String API的匹配方式 x-apigateway-ratelimit 否 String API绑定的流量控制名称 x-apigateway-request-type 否 String API的类型