检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到分组的子域名上,具体方法请参见增加CNAME类型记录集。
在“域名管理”区域,单击“绑定独立域名”,填写要绑定的域名。 图1 绑定独立域名 填写的独立域名必须已备案,并且已解析,详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3:创建API 在左侧导航栏选择“API网关代理 > API列表”。 单击“创建API”。
服务商入驻 服务商入驻 API订阅管理 API订阅管理 API资产管理 创建API资产 API网关代理 创建API分组 域名管理 创建API 调试API 发布API 授权API 下线API 创建凭据 创建策略 创建负载通道 创建环境 调用API API数据分析 API数据分析 API
表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。
支持区域: 华北-北京四 创建API资产 API网关注册 API中心服务商可以使用API中心的网关代理模块,进行API注册、发布、下线和删除,并支持配置流量控制、访问控制、签名密钥等策略来限制对API的访问,保护后端服务。
检查域名、方法、路径和注册的API是否一致。 检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名。 500 APIC.0103 The backend does not exist. 联系技术支持。
资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:创建API资产成功后,所有用户都能在API中心门户网站中看到该API资产。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
子域名:所在分组的调试域名。 路径:接口请求的路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置'+'号做前缀匹配,例如:/a/{b+}。 匹配模式 分为两种模式: 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。
API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:创建API资产成功后,所有用户都能在API中心门户网站中看到该API资产。
如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
开放API 上架API至API中心门户网站 注册API到网关代理
注册API到网关代理:将您的API注册到API网关代理,使您的服务能力变现,同时降低企业研发投入,让您专注于企业核心业务,提升运营效率。 消费API:在API中心门户网站中搜索您需要的API,用于系统集成和项目开发使用。
API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。 已注册华为账号并开通华为云,并已完成企业实名认证。 操作流程 对外开放API的操作流程如图1所示。 图1 对外开放API流程 入驻API中心服务商 进入API中心服务页面。
域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限使用的范围,称为环境。例如:API的测试环境,开发环境等。
子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。
在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则,可保障API的高可用性。