检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-plugins
x-apigateway-request-type 含义：API网关定义的API请求类型，支持public和private。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:
x-apigateway-match-mode 含义：API网关定义的API请求URL的匹配模式，支持NORMAL和SWA。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions
x-apigateway-is-send-fg-body-base64 含义：是否对与FunctionGraph交互场景的请求体进行Base64编码，boolean类型。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths
创建专享版实例（包周期） 功能介绍 创建包周期专享版实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/prepay-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎
如何获取API网关错误返回信息？ 当API请求到达网关后，网关返回请求结果信息。查看返回结果的Body信息如下。 { "error_code": "APIG.0101", "error_msg": "API not exist or not published to environment
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
x-apigateway-cors 含义：API网关定义的API请求是否支持跨域，boolean类型。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-cors
修改API 功能介绍 修改指定API的信息，包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明
修改API 功能介绍 修改指定API的信息，包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger
x-apigateway-ratelimits 含义：流控策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1/{project_id}/apigw/
查询标签列表 功能介绍 查询标签列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1/{project_id}/apigw/instances
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi URI中的参数说明如下表所示
x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
