检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Basic Auth:填写basic认证所使用的用户名。 Aes:填写Aes认证所使用的密钥Key。 Public Key:填写Public Key认证所使用的公钥。 Secret 根据选择的密钥类型,填写不同的密钥信息。 HMAC:填写APP认证所使用密钥对的Secret。 Basic
本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布接口变更公告,应当至少提前6个月在文档标识(使用@deprecated)为不建议
定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,在“后端配置”页面,配置后端服务信息。
单个API被调用次数上限。 与“时长”配合使用,表示“时长”时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅在API的安全认证方式为“华为IAM认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的单个用户请求次数上限。 如果主账号下有多个
本条规则是MUST类型的基本规则,可保障API的高可用性。 API发布是API生命周期中重要的部分,因此在发布过程中需要保证API的正确性、可读性、可用性,并对服务质量进行约束。 必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。
已注册华为账号并开通华为云,并已完成企业实名认证。 操作流程 对外开放API的操作流程如图1所示。 图1 对外开放API流程 入驻API中心服务商 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图2 入驻API中心服务商 也可以在API中心门户网站,单击页
Layer)是安全版超文本传输协议。 REST REST(Representational State Transfer,表征状态转移)网络上的所有事物都可被抽象为资源,每一个资源都有唯一的资源标识(resource identifier),对资源的操作不会改变这些标识,所有的操作都是无状态的,使用标准方法操作资源。
按不同维度搜索: 按API维度展示:展示所有API资产。可以在左侧勾选“分类”、“可见范围”或“API来源”,按照API资产所属行业、公开性或来源路径筛选API资产。 按服务商维度展示:展示所有API资产的服务商。可以在左侧勾选分类,按行业筛选API资产服务商。单击服务商,可以看到该服务商拥有的所有API资产。
选择来自华为云市场的API。 按API维度:在左侧“API来源”中勾选“华为云市场”。同时在左侧勾选“分类”、“可见范围”,筛选API资产所属行业、公开性。 按服务商维度:单击服务商名称,然后在左侧“API来源”中勾选“华为云市场”。同时在左侧勾选“分类”、“可见范围”,筛选API资产所属行业、公开性。
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图1 入驻API中心服务商 也可以在API中心门户网站,单击
说明: 允许或禁止访问的IP地址条数,分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时,需要设置。支持输入多个账号名,以英文“,”隔开,如aaa,bbb。 说明: 仅支持账号维
策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 进入API中心服务页面。 在左侧导航栏选择“API网关代理
PI描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
等待系统解析API文件。API资产所在行“状态”列如果显示“已上架”,说明解析完成。此时,API资产已成功分享至API中心门户网站。 如果您在华为云云商店上架了API资产,则API资产会周期性地自动上架至API中心门户网站,并展示在API资产列表页。 后续操作 创建完API资产后,您还可以执行表3的操作。
0个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道,每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率 不大于200次/秒。 特殊应用 每个流控策略最多可以创建30个特殊应用。
方式二:单击分组名称,在“API运行”页面,单击右上角的“上架”,跳转至“创建API资产”页面。 方式三:创建API资产时,“导入方式”选择“API网关”,然后选择API分组内已发布的API上架。 查看API的监控指标 单击分组名称,在“API运行”页面左侧选择API,在“监控视图”区域
Arts工具右下角的“前往使用”,进入API Arts工具界面。 参考API设计和API测试章节指导,在API Arts完成API的设计和测试。 上架API至API中心门户网站。 在API Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建A