检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
道详情。 开放API。 创建API分组。 在左侧导航栏中选择“API管理 > API分组”。 单击“创建API分组 > 直接创建”。 填写API分组信息后,单击“确定”。 创建API并绑定已创建的负载通道。 单击已创建的API分组名称,进入分组详情页面,在“API运行”页签中单击“创建API
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
API发布到不同环境后,会调用不同的后端服务吗? 使用环境变量,或者在后端服务定义不同的参数,可以实现API发布到不同环境后,调用不同的后端服务。 有关环境变量的详细指导,请参考创建环境变量。 父主题: 发布API
准。 您需要使用独立域名/调试域名访问,使用调试域名访问时存在单日访问次数限制。可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。 例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用
Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明
API_CONDITION_NUM_LIMIT:每个API策略后端可以设置的条件个数限制 SL_DOMAIN_CALL_LIMIT:每个二级域名单位时间内的请求默认限制 ELB_SWITCH:是否启用ELB通道 AUTHORIZER_NUM_LIMIT:租户可创建的自定义认证个数限制
头,3-255字符 说明: 中文字符必须为UTF-8或者unicode编码。 plugin_type String 插件类型。 cors:跨域资源共享 set_resp_headers:HTTP响应头管理 kafka_log:Kafka日志推送 breaker:断路器 rate_limit:
String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type
功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
error_code String 错误码 error_msg String 错误描述 请求示例 更新跨域共享插件 { "plugin_name" : "跨域插件", "plugin_type" : "cors", "plugin_scope" : "global", "plugin_content"
前提条件 已创建API。 调试API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页签,选择待调试的API,单击“调试”。 配置URL和API请求参数。 选
功能介绍 查询API分组列表。 如果是租户操作,则查询该租户下所有的分组;如果是管理租户操作,则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups[
String 错误码 error_msg String 错误描述 请求示例 创建一个跨域共享插件 { "plugin_name" : "跨域插件", "plugin_type" : "cors", "plugin_scope" : "global", "plugin_content"
专享版与共享版的差异 API网关当前提供共享版与专享版两种服务方式。其中共享版API即开即用,专享版API网关需要购买专享版实例,并在实例中管理API。 专享版API网关常用于企业内部系统解耦,各服务部署在云上的VPC内,服务之间以RESTful API方式通信,通信链路在VPC
创建用于前端自定义认证的函数:API网关利用函数对收到的API请求进行安全认证。 创建用于后端自定义认证的函数:API后端服务利用函数对来自API网关转发的API请求进行安全认证。 后端服务签名校验开发:若API在API网关上绑定了签名密钥,则API网关向该API的后端服务发送请求时会携
此时API调用者调用此API时,API的匹配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到不同环境后,会调用不同的后端服务吗? 后续操作 API发布完
成”。 发布API。 在左侧导航栏选择“API管理 > 凭据管理”,创建凭据。 单击“创建凭据”,填写凭据名称后,然后单击“确定”。 绑定API。 单击凭据名称,进入凭据详情。在“关联API”区域,单击“绑定API”,选择API并“确定”。 验证。 您可以通过API网关的调试页面调用API,验证双重认证是否成功。