检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
PI后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。 同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 URI HTT
完成API的创建、发布等工作 此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 (可选)配置API的流量控制策略 流量控制主要用来限制单位时间内API的被调用次数,保护后端服务的稳定。 此部分
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
der”的初始值为空,与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”,那么对于APP认证的API,请求header中携带APP认证信息的参数为此处“app_auth_header”的值;如果配置“backend_sign_header”的“参数运行
Integer 符合条件的签名密钥的数量 size Integer 本次返回的列表长度 signs 字典数据类型 本次查询到的签名密钥列表 表4 signs参数说明 参数 类型 说明 id String 签名密钥的编号 name String 签名密钥的名称 sign_key String
接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 sl_domain_access_enabled 是 Boolean 设置调试域名是否可以访问,true为可以访问,false为禁止访问 缺省值:true 响应参数
certificate/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 无 状态码 表3
功能介绍 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟、小时、天。 查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一个样本,其样本值为一小时内的累计值,服务器
例信息中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request
查看APIG的监控指标 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面左侧选择API。
单个IP地址(客户端IP地址)调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的IP地址请求次数上限。 描述 关于控制策略的描述。 单击“确定”。
流量控制可限制单位时间内API的被调用次数,保护后端服务。 为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 流控策略和API本身是相互独立的,只有将流控策略绑定API后,流控策略才对绑定的API生效。 同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。
指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的签名密钥的数量 size Integer 本次返回的列表长度 signs 字典数据类型 本次查询到的签名密钥列表 表4 signs参数说明 参数 类型 说明
在弹窗中配置策略信息。 表1 绑定访问控制策略 参数 说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。
创建App Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apig
项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
怎样给指定的用户开放API? 可以采用以下两种方式: 创建API时可选取APP认证方式,APP key和APP Secret分享给指定的用户。 使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 父主题: API策略
广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制,如果当前WebSocket连接空闲时间超过了配置的超时时间,并且没有ping/pong保活,则连接会被自动断开。
vs[?page_no, page_size,name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:name、page_size、page_no。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? API可以绑定内网域名吗? 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published