检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API 通过APIG创建REST API 通过APIG创建GRPC API 父主题: 开放API
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
Key 与“Secret”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Key。 Basic:填写basic认证所使用的用户名。 Secret 与“Key”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Secret。 Basic:填写basic认证所使用的密码。
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。
查看应用绑定的API详情 操作场景 在应用绑定API后,查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击待查看的API名
开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间。 单位:s。 Access-Control-Allow-Origin * 允许任何域。 Access-Control-Allow-Headers X
为简易认证添加AppCode 操作场景 简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填应用详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认
API网关支持专享版和共享版(存量用户)功能。共享版功能已下线,不支持新用户使用,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用),其余为专享版功能操作指导章节。 使用流程 使用API网关进行API的托管流程如下图所示。 图1 业务使用流程 创建用户并授权使用APIG
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上
配置API策略 配置API的传统策略 配置API的插件策略
4e8c","7addcd00cfab433984b1d8bf2fe08aaa"] } 响应消息 表4 参数说明 名称 类型 说明 success_count Number 删除成功的ACL策略数量 failure Array 删除失败的ACL策略及错误信息 表5 failure参数说明
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
配置凭据策略 配置API认证凭据的配额控制 配置API认证的凭据访问控制
调用API 调用APIG开放的API 跨域调用APIG开放的API APIG的API响应消息头说明 APIG的API错误码说明
使用APIG专享版开放云容器引擎CCE工作负载 使用APIG专享版开放云容器引擎CCE工作负载方案概述 使用APIG专享版开放云容器引擎CCE工作负载资源规划 使用APIG专享版开放云容器引擎CCE工作负载操作流程 使用APIG专享版开放云容器引擎CCE工作负载实施步骤 父主题: 开放API
使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《开发指南》。
1,那么采样的线上请求流量为100。 超时时间(ms) 镜像请求的超时时间,单位ms。默认超时时间为5000ms。 客户端请求体 镜像客户端的请求体,默认开启镜像客户端请求体。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。
securityDefinitions 是 Object 定义鉴权方式,参考表13 x-apigateway-access-controls 否 Object 访问控制信息,参考表 x-apigateway-access-controls参数说明 x-apigateway-ratelimits 否 Object
720000s。 缓存策略模式 网关通过客户端请求中的Cache-Control请求头来处理缓存,默认拒绝所有客户端带Cache-Control头的请求。 all:允许所有客户端带Cache-Control头的请求。 off:拒绝所有客户端带Cache-Control头的请求。