检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上,具体方法请参见增加CNAME类型记录集。
图1 绑定独立域名 填写的独立域名必须已备案,并且已解析,详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3:创建API 在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。 配置前端定义。
{Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。
子域名:所在分组的调试域名。 路径:接口请求的路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置'+'号做前缀匹配,例如:/a/{b+}。 匹配模式 分为两种模式: 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。
API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:创建API资产成功后,所有用户都能在API中心门户网站中看到该API资产。
资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:创建API资产成功后,所有用户都能在API中心门户网站中看到该API资产。
检查域名拼写,以及域名是否绑定了正确的后端地址。 500 APIC.0606 Failed to load the API configurations. 联系技术支持。
API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。 已注册华为账号并开通华为云,并已完成企业实名认证。 操作流程 对外开放API的操作流程如图1所示。 图1 对外开放API流程 入驻API中心服务商 进入API中心服务页面。
子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。
域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限使用的范围,称为环境。例如:API的测试环境,开发环境等。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
支持区域: 华北-北京四 创建API资产 API网关注册 API中心服务商可以使用API中心的网关代理模块,进行API注册、发布、下线和删除,并支持配置流量控制、访问控制、签名密钥等策略来限制对API的访问,保护后端服务。
(可选)单击“自定义配置”后面的,展开自定义配置区域,可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。
在“安全配置”中,安全认证选“无认证”,勾选“开启支持跨域CORS”。 后端配置选择“Mock”。 图3 预检请求-后端选Mock 简单请求 对于简单请求,您需要开启简单跨域访问。
华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。
后续操作 创建API,将部署在负载中的后端服务开放API,从而实现后端服务的负载均衡。 父主题: API策略
应用流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip 源IP流量限制信息 示例:remain:9,limit