检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
资产的开发文档,可以查看API的详细信息。 获取API的调用凭据 需要付费购买的API(来源于华为云市场的API),可按照页面引导和提示,完成API购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 不
服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。
取消入驻服务商 生产API API中心为开发者引入自动化的API工具(如API Arts),帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。 支持区域: 华北-北京四 使用API Arts开发API API资产分享 API中心
可按照页面引导和提示,完成API购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 不需要付费购买的API(技术开放型API),可根据API使用指南(如果有)或者联系API服务商获取API调用凭据。 华
已创建凭据,或已获取其他用户的凭据ID。 在流控策略详情页面,单击“特殊应用”页签,进入特殊应用页面。 单击“添加特殊应用”,弹出“添加特殊应用”对话框。 通过以下两种方式,添加特殊应用。 添加已有应用:单击“已有应用”,选择已有凭据名称,输入阈值。 添加其他应用:单击“其他”,输入其他用户的凭据ID和阈值。
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项
根据下表参数信息,配置安全配置。 表3 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,在“后端配置”页面,配置后端服务信息。
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
避免出现因请求消息体格式错误导致的执行异常。 API的默认媒体类型为“Content-Type: application/json”和“charset=UTF-8”。 当使用非application/json媒体类型时,建议根据情况选择合适的媒体格式,具体情况如表2所示。 表2 常见的媒体类型
全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全,涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身,也包括运维运营安全,以及更广义的安全合规遵从。 租户:负责云服务内部的安全,安全地使用云。
"count":1540 } API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取,输出参数要让开发者易于理解。降低开发者使用API的使用成本,提升API使用体验。避免API的输入
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
将新创建的签名密钥绑定API。 API网关代理将签名后的请求发送到后端服务,此时Authorization头中包含签名信息。后端服务通过不同的开发语言(例如Java、Go、Python、JavaScript、C#、PHP、C++、C等)进行签名,通过比对签名结果和API网关代理传过来
附录-API治理规范指导 概述 规范要求 工具平台
收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。 在API设计过程中,使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中,POST请求是向指定
表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。 APP认证(简易认证) 向API提供方获取该API所授权凭据的AppCode。 APP认证(app_secret认证) 向API提供
debug,且API配置了用户流量限制时,返回此参数 X-Apig-RateLimit-app 应用流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip
认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey用于进行身份认证,该认证方法直接传递密钥,在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,
发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率 不大于200次/秒。 特殊应用 每个流控策略最多可以创建30个特殊应用。 特殊租户 每个流控策略最多可以创建30个特殊租户。 子域名访问次数 每个子域名每天最多可以访问1000次。 调用请求包的大小
当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性