检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
例如:易于理解的API名称应为“查询虚拟机列表”/“ListServers”、“创建VPC网络”/“CreateVPC” API描述信息必须易于理解,表述准确 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API描述信息要易于理解,字面表述准确,能说明API的用途,场景及约束。
此步骤。 在域名所在行单击“添加SSL证书”。 根据下表参数信息,配置SSL证书。 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法,推荐您使用ECDSA和DSA加密算法。 表2 SSL证书配置 参数 配置说明
API数据分析页面通过图表的形式,直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。 表1 资源概览参数说明
API。 后续操作 创建API分组成功后,您还可以执行如表3的操作。 表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
单击“环境变量”页签后面的,展开环境变量区域。 选择环境。如果未创建环境,可单击“创建环境”创建。 单击“添加环境变量”,填写变量信息。 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。 表1 新增变量 信息项 描述 变量名 变量的名称,必须与创建API时定义的变量标识完全相同。
ERY”。 描述 填写系统参数的描述信息。 (可选)添加策略后端。 添加多个后端策略后,通过不同的策略条件,请求被转发到不同的后端服务中。 单击添加策略后端。 后端策略增加的参数,具体如表8所示,其他参数说明参考表4和表5。 表8 后端策略参数 信息项 描述 后端策略名称 您自定义的名称,用于识别不同的后端策略。
通过集群提供服务,集群中每个微服务都有多个实例,当一个或部分实例异常时,其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中,RDS实现了AZ容灾方案,数据持续会同步到容灾站点,当生产站点的RDS异常后,容灾站点可以接管业务,保障云服务持续运行。 父主题: 安全
遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之
与“时长”配合使用,表示“时长”时间内的IP地址请求次数上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据,或已获取其他用户的凭据ID。 在流控策略详情页面,单击“特殊应用”页签,进入特殊应用页面。 单击“添加特殊应用”,弹出“添加特殊应用”对话框。 通过以下两种方式,添加特殊应用。
选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI
API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问A
泡,请在样式中增加 js-title 如果title超长,将自动截断(文字超长时,列表项样式改为:listitem_qFLwPs2_100) 03 入门 弹性云服务器(Elastic Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 登录云服务器 什么是ECS
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“负载通道”页签,进入到负载通道列表页面。 单击“创建负载通道”,配置基本信息。 表1 基本信息配置 信息项 描述 通道名称 自定义负载通道名称,用于识别不同的负载通道。 端口 负载通道中主机的端口号,即用户的后端业务端口号。
约束与限制 API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
已创建环境。 已创建凭据。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如
API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。
负载通道 环境管理 创建策略 流量控制策略 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP
在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret。 APP认证(app_basic认证) 在API请求中添加Heade
PI服务。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: API列表