检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
每个API建议带上版本号,保证API的版本显性化,容易被API调用者所识别。版本号建议放置在URI中,用于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”,这里X是一个正整数如:v1,v2等,要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布
如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况 如果您想要查看已发布的API
最新动态 本文介绍了API中心各特性版本的功能发布和对应的文档动态,欢迎体验。 2023年7月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 仅支持华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 商用 服务商入驻 2 优化变更服务商信息
扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果,并自动下载文件。 父主题: API列表
商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订阅的API单个或批量取消订阅:参考取消订阅API。 查看订阅的所有API 进入API中心服务页面。
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默认返回数量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外,华为云还提供了以下销售许可证及软件著作权证书,供用户下载和参考。具体请查看合规资质证书。 图3 销售许可证&软件著作权证书 父主题: 安全
易用性:对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议,提升API调用者使用体验。 可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。 生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。
如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看Key和Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。
商。单击服务商,可以看到该服务商拥有的所有API资产。 查看系统精选API 勾选“仅看精选”,界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后,单击API资产,查看API资产的开发文档,可以查看API的详细信息。 获取API的调用凭据 需要付费购买的A
APIC.0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized
数据10分钟刷新一次。 在“API监控”区域,展开API右侧的下拉框,选择您想要查看调用情况的API。 选择要查看的时间范围。支持查看近1个小时、近6个小时、近24个小时或近7天的调用情况。 查看API监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。 统计数据每10分钟刷新一次。
示在API资产列表页。 后续操作 创建完API资产后,您还可以执行表3的操作。 表3 后续操作 操作 说明 查看API资产详情 在API资产列表页,单击API资产名称,查看API资产详情。 修改API资产信息 在API资产列表页,单击API资产所在行“操作”列的“编辑”,修改API资产信息。
API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。 API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 前提条件
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。
API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。 API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 父主题:
(可选)在线调测API。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付