检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限使用的范围,称为环境。例如:API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头
关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 父主题: 安全
负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。 例如,负载中包含6台ECS,已创建一条负载通道,其中ECS
和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。
vers”、“创建VPC网络”/“CreateVPC” API描述信息必须易于理解,表述准确 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API描述信息要易于理解,字面表述准确,能说明API的用途,场景及约束。 API描述信息建议使用Markdown格式
与“API流量限制”配合使用,表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示“时长”时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示“时长”时间内的单个IP地址请求次数上限。
请求Path为前缀,支持接口定义多个不同Path。 例如,请求路径为/test/AA,使用前缀匹配时,通过/test/AA/CC可以访问,但是通过/test/AACC无法访问。 说明: 使用前缀匹配时,匹配剩余的路径将透传到后端。 例如,使用前缀匹配,前端请求路径定义为/test
用于部分更新资源的场景,如果使用PUT操作所需输入的整体资源信息内容大小与PATCH操作无太大差异,优先使用PUT操作,不推荐使用PATCH操作。 是 OPTIONS 获取当前资源支持哪些方法的信息。 是 例如:使用正确的HTTP动词。 “查询虚拟机列表”:GET /servers “创建VPC网络”:POST
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加
to the backend IP address has been denied. 使用可用的IP地址访问后端服务。 403 APIC.0405 The app is not accessed from a trusted IP address. 检查IP地址是否被客户端访问控制策略限制。
服务商入驻成功后信息还可以修改吗? 可以,API中心支持您修改服务商信息。具体修改方法,参考变更服务商信息章节。 父主题: 服务商入驻
服务商入驻成功后可以取消入驻吗? 可以,API中心支持您取消入驻服务商。具体取消方法,参考取消入驻服务商章节。 父主题: 服务商入驻
API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
Origin:此字段必选,表示请求消息所属源。 Access-Control-Request-Method:此字段必选,表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。 后端服务返回消息:无。
华北-北京四 使用API Arts开发API API资产分享 API中心服务商可以通过在管理控制台创建API资产,将开发好的API分享至API中心门户网站,供其他开发者集成和调用。 支持区域: 华北-北京四 创建API资产 API网关注册 API中心服务商可以使用API中心的网关
HMAC:填写APP认证所使用密钥对的Key。 Basic Auth:填写basic认证所使用的用户名。 Aes:填写Aes认证所使用的密钥Key。 Public Key:填写Public Key认证所使用的公钥。 Secret 根据选择的密钥类型,填写不同的密钥信息。 HMAC:
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项