检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
准备网络环境 负载 虚拟私有云（Virtual Private Cloud，简称VPC）。实例需要配置虚拟私有云（负载），在同一负载中的资源（如ECS），可以使用实例的私有地址调用API。 在创建实例时，建议配置和您其他关联业务相同负载，确保网络安全的同时，方便网络配置。 安全组 安全组类似
适用计费项 表1 按需计费适用计费项 计费项 说明 版本（实例规格） API网关提供的实例版本有：基础版、专业版、企业版、铂金版等，您可以根据实际业务需要按需使用。实例版本说明，请参考产品规格。如果您当前使用的实例版本不能满足需要，API网关支持升级产品版本，例如从“基础版”
查询插件详情 功能介绍 查询插件详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
使用Swagger文件导入API时是否有模板？ 模板在开发中。 您可以先配置好1~2个API，再导出作为模板。 父主题： 导入导出API
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
修改插件 功能介绍 修改插件信息。 插件不允许重名 插件不支持修改类型和可见范围 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数，支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控，与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。
删除环境 操作场景 已创建的环境不再提供服务，可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”，进入到环境管理信息页面。 在待删除的环境所在行，单击“删除”，弹出对话框。 仅在环境未被API发布时，支持删除。 单击“确定”，完成环境管理信息。
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attachable-plugins
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的，绑定API后，对绑定的API即时生效 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/plugins
查询已购买的API分组列表 功能介绍 租户可以查询自己已购买的API分组列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/purchases/groups[?page_size
requestId","apiId":"$context.apiId"} JSON体的内容可以按需定制，包括增减字段内容。 API提供的默认网关响应“default”也可以编辑修改。 您可以新增多个网关响应，支持同一分组下不同API配置不同的网关响应内容。 网关响应所定义的错误类
"apiId":"$context.apiId"} JSON体的内容可以按需定制，包括增减字段内容。 约束与限制 每个分组最多可新增4个网关响应。 最多支持10个响应头自定义，响应头的key支持数字、英文字母和下划线（1到128位），value可以引用运行时变量（可以引用的变量见API网关运行时可获取变量）
校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证，且开启了简易认证模式，API请求既可以选择使用Appkey和AppSecret做签名和校验，也可以选择使用AppCode进行简易认证。 为了确保安全，简易认证仅支持HTTPS方式调用API，不支持HTTP。
（凭据）的持有者才可以调用已发布到环境中的指定API。 同一个API发布到不同的环境时，可以为之定义不同的流控策略并授权给不同的应用（凭据）。举例，API v2版本在测试过程中，可以发布到BETA环境，并授权给测试应用（凭据），而API v1版本是稳定版本，可以在RELEASE环
这些账号或者云服务可以根据权限进行代运维。 如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用API网关服务的功能。 本章节为您介绍对用户授权的方法，操作流程如图1所示。 前提条件 给用户组授权之前，请您了解用户组可以添加的表1，并结合实
关也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证，且开启了简易认证模式，API请求既可以选择使用Key和Secret做签名和校验，也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全，简易认证仅支持HTTPS或GRPCS方式调用API，不支持HTTP。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
