检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG最佳实践汇总 本文汇总了基于API网关服务(APIG,APIGateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud
解除绑定插件的API 功能介绍 解除绑定在插件上的API。 解绑及时生效 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/detach 表1 路径参数
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apig
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
ratelimit_api_limits API全局默认流控值,默认值为200次/秒。API未绑定流控策略时,执行此默认流控;API绑定流控策略时,则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。 request_body_size API请求中允许携带的
解除绑定API的插件 功能介绍 解除绑定在API上的插件。 解绑及时生效 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/plugins/detach 表1
专享版-API管理 创建API 修改API 删除API 发布或下线API 查询API详情 查询API列表 校验API定义 调试API 批量发布或下线API 查询API历史版本列表 切换API版本 查询API运行时定义 查看版本详情 根据版本编号下线API 父主题: 专享版API(V2)
API绑定流控策略 对象模型 查看流控策略未绑定的API列表 绑定流控策略 查看流控策略绑定的API列表 查看API绑定的流控策略列表 解除绑定 父主题: 共享版API(仅存量用户使用)
API导入导出(待下线) 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 专享版API(V1)(待下线)
创建完成后,才能开放API并对外提供服务。 开放API 创建一个支持简易认证的API,后端服务为Mock类型,方便调试验证API。然后调试已创建的API,无问题后进行发布。 调用API 创建一个凭据,并添加一个AppCode作为调用API的凭证。然后使用接口测试工具,通过校验AppCode来实现对API的调用。
签管理服务”搜索。 进入标签管理服务控制台,填写搜索信息搜索,过滤实例资源。 区域:选择API网关所在区域。 资源类型:选择“APIG”。 资源标签:选择已添加的标签键。 父主题: 管理APIG实例
API调用对请求的响应消息体限制 API调用对请求的响应体大小没有限制。 API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 父主题: 调用API
兼容性说明 支持OpenAPI规范。 OpenAPI规范(OAS),是定义一个标准的、与具体编程语言无关的RESTful API的规范。OpenAPI规范的前身是Swagger规范,API网关目前支持两种OpenAPI规范:Swagger 2.0或OpenAPI 3.0。为了方便区分
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
使用Swagger文件导入API时是否有模板? 模板在开发中。 您可以先配置好1~2个API,再导出作为模板。 父主题: 导入导出API
启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id} 表1
策略创建后,您还需要为策略绑定API,才能使策略对API生效。 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。
调用已发布的API 调用API 响应消息头 错误码 父主题: 共享版操作指导(仅存量用户使用)
app_token_uri 获取token的uri。 /v1/apigw/oauth2/token - app_token_key token的加密key。 - - app_api_key 是否开启app_api_key认证方式。 是 {"name":"app_api_key","enable":true