检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品规格。 版本实例包年/包月单价,请参考价格详情中的价格。 购买时长 使用API网关版本实例的时长,支持购买1~9个月,或者1~3年。 购买个数 使用实例的个数。 公网带宽 API请求出公网带宽,按实际使用的带宽大小和时长计费。 假设您计划购买APIG专业版(未开启公网带宽),
APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud Container Engine,即CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。 使用APIG专享版开放本地数据中心的服务能力 使用专享版API网关为本
PI分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
断路器的触发次数统计时间窗,与“阈值”或“最小百分比”参数配合使用,当时间窗内的触发次数达到设定阈值或百分比,则触发断路器。 阈值(次) 仅当“条件模式”选择“计数器”时需配置。 断路器的触发阈值,与“时间窗”参数配合使用。在时间窗内,满足触发条件的后端请求次数达到阈值,则触发断路器。
日志包含请求头域信息:勾选后,需填写日志中要携带的请求Header参数。多个字段间使用英文逗号(,)分隔,支持使用*进行通配设置。 日志包含请求QueryString信息:勾选后,需填写日志中要携带的请求Query参数信息。多个字段间使用英文逗号(,)分隔,支持使用*进行通配设置。 日志包含请求Body体信息:勾
流量限制的时长。 与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。 与“源IP流量限制”配合使用,表示单位时间内的单个IP地址请求次数上限。
流量限制的时长。 与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示单位时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示单位时间内的单个IP地址请求次数上限。
用后,可在API请求中使用获取的access_token进行API的调用认证。 app_token_expire_time:access_token的有效时间,在access_token到期前,请及时获取新的access_token并更新,避免影响正常使用。 refresh_to
在绑定签名密钥后,API网关到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与API网关的签名信息是否一致。 使用HTTPS对请求进行加密。 需要确保已有相应的SSL证书。 使用后端认证: 您可以对后端服务开启安全认证,只受理携带正确授权信息的API请求。在创建API的定义后端服务阶段,可以开启后端认证。
负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时,配置鉴权服务的负载通道。 选择“不使用”时,配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。 请求协议 HTTP或HTTPS,传输重要或敏感数据时推荐使用HTTPS。
流量限制的时长。 与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示单位时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示单位时间内的单个IP地址请求次数上限。
息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 protocol 是 String 使用以下协议,对VPC中主机执行健康检查: TCP HTTP HTTPS path 否 String 健康检查时的目标路径。protocol =
是否必选 参数类型 描述 protocol 是 String 实例自定义入方向端口协议。 HTTP:实例自定义入方向端口使用HTTP协议。 HTTPS:实例自定义入方向端口使用HTTPS协议。 ingress_port 是 Integer 实例自定义入方向端口,支持的端口范围为1024~49151。
描述 CRU 否 vpc_status Integer 是否使用VPC通道 1:使用 2:不使用 CRU 否,默认不使用 vpc_info String VPC通道信息 CRU 否 如果vpc_status=1,即:使用VPC通道,则该字段必填 authorizer_id String
迟性能。 表1 QPS性能参考 实例规格 基础版 专业版 企业版 铂金版 铂金版x2 连接类型 应答字节数(KBytes) 是否使用HTTPS 是否使用gzip CPU处于安全水位(30%)的QPS参考 短连接 1 否 否 3500 3600 9000 55000 72000 是
持,可使用80默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该参数,则必须同时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。
API在发布到环境1时,使用“/Stage/test”代替“Path”,API调用者在环境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代
多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求,可以把参数值设置为“*”,表示允许来自所有域的访问请求。 Allowed Methods Access-Control-Allow-Methods响应头,指定允许使用的HTTP请求方法,多个请求方法之间使用英文逗号隔开。
添加API的SSL证书(可选) 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。 创建API的负载通道(可选) 通过创建负载
tatus = 1,则这个object类型为必填信息 vpc_channel_status 否 Integer 是否使用VPC通道 1:使用VPC通道 2:不使用VPC通道 表11 ApiPolicyHttpCreate 参数 是否必选 参数类型 描述 url_domain 否 String