检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”,这里X是一个正整数如:v1,v2等,要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本,哪些版本是支持但已经不推荐的版本,方便API调用者通过该接口快速了解与跟进服务API的变化。如
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布
最新动态 本文介绍了API中心各特性版本的功能发布和对应的文档动态,欢迎体验。 2023年7月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 仅支持华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 商用 服务商入驻 2 优化变更服务商信息
单击“更多 > 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者
地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API对外开放时,API文档建议使用统一的模板,以便保持API参
扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果,并自动下载文件。 父主题: API列表
可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。 生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。
需匹配,形成API生产、消费、再生产的良性循环。 了解 进入控制台 成长地图 由浅入深,带您玩转API中心 弹性云服务器一 弹性云服务器二 弹性云服务器三 弹性云服务器四 01 了解 了解API中心,有助于您快速掌握API中心功能,高效便捷地分享和开放API,或快速查找所需API进行应用开发和集成。
Region级部件实现跨AZ双活,一个AZ异常时不影响云服务持续提供服务。 AZ内集群容灾 通过集群提供服务,集群中每个微服务都有多个实例,当一个或部分实例异常时,其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中,RDS实现了AZ容灾方案,数据持续会同步到容灾站点,当生产站点的RD
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击,华为云在遵从法律法规业界标准的基础上,以安全生态圈为护城河,依托华为独有的软硬件优势,构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任,如图1所示。
代理服务器尝试执行请求时,从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式,响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则,可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验,避免出现因请求消息体格式错误导致的执行异常。
表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址
API涉及个人数据时,需要提供隐私声明 本条规则是MUST类型的基本规则,可保障API的安全合规。 如果API提供正常业务时涉及个人数据(包含收集、使用、转移、存储等),必须在API发布过程中提供产品隐私声明,描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。
有API。其中,商业售卖的API,基于华为云云商店实现交易和变现。 ROMA Connect的APIC模块作为底层组件为API中心提供网关实例资源,API中心的网关代理对外提供逻辑多租能力,构建面向生态伙伴/开发者的API生态网关。 访问方式 API中心分为API门户和管理控制台。
禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则,可保障API的高可用性。 API通道默认请求报文体长度(Body Size)限制为2MB,默认请求Header长度(Header Size)限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则,可提升API的可用性。
自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。 签名算法 选择Aes的签名算法,包含以下两种: aes-128-cfb aes-256-cfb Key 根据选择的密钥类型,填写不同的密钥信息。
给后端服务。 字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例