检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑
控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“类型”为“IP地址”时,需要设置。
在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性
通过集群提供服务,集群中每个微服务都有多个实例,当一个或部分实例异常时,其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中,RDS实现了AZ容灾方案,数据持续会同步到容灾站点,当生产站点的RDS异常后,容灾站点可以接管业务,保障云服务持续运行。 父主题: 安全
in:此字段必选,“*”表示API网关代理接受任意域的请求。 Access-Control-Allow-Headers:当请求消息中包含此字段时,此字段必选。表示允许跨域的所有请求头信息字段。 Access-Control-Expose-Headers:表示跨域访问允许查看的返回头信息字段。
变更服务商信息 服务商入驻成功后,您如果想要修改服务商信息,可以参考本章指导操作。 前提条件 仅允许华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 在服务商入驻页面,单击“变更服务商信息”
量控制。 访问控制 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据,也支持将多个API授权给同一个凭据。
取消入驻服务商 您如果想要取消在API中心入驻服务商,可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商,不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
格式:“主机:端口”,主机为IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 端口范围:1 ~ 65535。 如果需要创建变量标识,则填写“#变量名#”,如#ipaddress#。支持创建多个变量标识,如#ipaddress##test#。
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。
2023年7月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 仅支持华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 商用 服务商入驻 2 优化变更服务商信息 仅支持华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 商用
一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 前提条件 已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。
流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。
户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例
API请求参数说明,包括Header、Query参数,需要明确字段内容和取值范围。 API请求Body内容,Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码,状态码及对应的说明。 API响应参数说明包括Header参数,需要明确字段内容和取值范围。 API正常响应Body内容
工具平台 API生产阶段 API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。上架成功后,API
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
时设置的“阈值”限制,其他凭据调用API次数的上限,仍然受本参数值限制。 源IP流量限制 单个IP地址调用API次数上限。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的IP地址请求次数上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据,或已获取其他用户的凭据ID。