检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。
请求方法:接口调用方式,默认“POST”。 请求协议:选择API请求协议,默认“GRPCS”。 子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 路径:接口请求路径。此处填写“/helloworld.Greeter”。请求路
API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https) 约束与限制
便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 图1 同一区域跨VPC访问 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在已创建的实例上,单击“查看控制台”或实例名称。
如果需要使用自定义认证方式进行API的安全认证,请创建自定义认证。 前端配置 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“创建API > 创建API”。 根据下表参数信息,配置前端定义。
每个分组最多创建1000个API。 x 后端策略数量 每个实例最多创建5个后端策略。 √ 应用(凭据)数量 每个实例最多创建50个应用。应用配额包括用户自行创建的应用。 √ 流控策略数量 每个实例最多创建300个流控策略。 用户流量限制不超过API流量限制。 应用(凭据)流量限制不超过用户流量限制。 源IP流量限制不超过API流量限制。
API受API超时时间的限制,如果当前WebSocket连接空闲时间超过了配置的超时时间,并且没有ping/pong保活,则连接会被自动断开。 前提条件 准备一个已做ping/pong保活的WebSocket服务后端。 操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
查看API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理 > API列表”,进入到API列表页面。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
单向认证无需配置CA证书。 单击“确定”创建完成。 绑定域名。 在左侧导航栏选择“API管理 > API分组”。 单击API所属分组名称,进入分组详情。 在“分组信息”页签中单击“绑定独立域名”。 表2 配置独立域名 参数 配置说明 域名 填写已备案的域名。 支持最小TLS版本 此处选择“TLS1
说明 api-limit 是 Integer API访问次数限制 user-limit 否 Integer 用户访问次数限制 app-limit 否 Integer 应用访问次数限制 ip-limit 否 Integer 源IP访问次数限制 interval 是 Integer 流控策略时间周期
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts"
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
on 绑定域名 ApiGroup AssociateDomain 绑定域名证书 ApiGroup AssociateCertificate 修改域名 ApiGroup UpdateDomain 解绑域名 ApiGroup DisassociateDomain 删除域名证书 ApiGroup
等待流控刷新后访问。如果触发子域名的单日请求数上限,请绑定独立域名。 APIG.0310 The project is unavailable. 403 project不可使用 使用其他project访问 APIG.0311 Incorrect debugging authentication
x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true:支持 false:不支持 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间 单位:s Acce
单配置需要提前放通,防止网络问题导致业务受损!期间请勿对实例进行任何操作! 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 单击待变更实例右侧的“更多 > 规格变更”。 实例参数信息请参考表1,选择升级规格,单击“下一步”。 确认信息无误后,勾选服务协议,单
后端服务地址是否一定要配置为ECS的地址? 后端服务地址可以配置为ECS的弹性公网IP,也可以配置为您自己服务器的公网IP地址,还可以配置为域名。 有关API后端配置的详细指导,请参考创建API。 父主题: API创建