检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API策略 是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
产品咨询 如何将API服务上架到华为云商店上售卖? API分组为什么无法上架到云商店? API、环境、凭据之间的关系? API网关共享版是否可以升级到专享版? APIG控制台所有按钮均无法单击如何处理? 怎样保护API的调用安全? 怎样保证API网关调用后端服务器的安全?
对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到不同环境后,会调用不同的后端服务吗? 调试API的时候,如何指定环境?
API调用次数超出所配置的流量策略阈值 凭据未授权 401 使用的凭据未被授权访问该API API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.apiName API名称 $context
Engine,即CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。 使用APIG专享版开放本地数据中心的服务能力 使用专享版API网关为本地数据中心搭建一条与API网关(所绑定的华为云VPC)之间的专线。 使用FunctionGraph服务实现APIG的自定义认证
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过配置流控策略,针对部分API进行流量控制。 约束与限制 API配置流控策略相当于流控策略同步绑定了API。同一
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H
创建告警规则 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name
单击“创建函数”,根据下表参数说明,创建一个函数。 表1 配置函数 参数 说明 函数类型 选择函数的类型,此处默认“事件函数”。 区域 选择与API网关相同区域。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问
铂金版X依次增加4个私有地址。),上下游服务(服务端和客户端)需要酌情调整网络安全策略,保证网络可达。如果下游存在跨VPC调用的场景时,需要通过VPC终端节点对接到APIG专享版的VPC终端节点服务上,以保证网络可达。具体操作详见实施步骤。 调试域名的变化 原共享版的分组调试域名{group-id}
单击“创建函数”,根据下表参数说明,创建一个函数。 表1 配置函数 参数 说明 函数类型 选择函数的类型,此处默认“事件函数”。 区域 选择与API网关相同区域。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问
账单出账时间通常在当前计费周期结束后一小时内,最长不超过三个小时。 适用计费项 使用量(包含API调用量和公网流量) 如果后端服务与API网关不在同一区域,或后端服务不在华为云,将会额外收取API网关到后端服务的流量费用。 适用场景 适用于API需求较小的场景。 父主题: 计费模式
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。
创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《开发指南》。 使用无认证、华为IAM认证的API、自定义认证,无需创建凭据。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 自定义客户端访问端口
境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。
在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证需要借助函数工作流服务实现。 父主题: 使用APIG的APP认证和自定义认证实现API的双重认证
删除流控策略 操作场景 当已创建的流控策略不再提供服务时,可以将此流控策略删除。 前提条件 已创建流控策略。 操作步骤 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。