检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，POST请求是向指定的资源提交要被处理的数据，其响应不会被缓存；PUT请求用来提交数据时，其响应是不能被缓存的。 父主题： API生产
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API生产 安全性 可用性 易用性 可维护性 父主题： 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题： 规范要求
阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
名访问分组内的API。 环境 为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般
合规证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外，华为
本条规则是Should类型的扩展规则，可提升API的可用性。 在API的设计阶段需要对单位时间可处理的能力进行设计，指标包括吞吐量和并发量。 吞吐量（TPS）是指服务在单位时间内处理请求的数量，使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。 服务API的最大吞吐量
Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回
aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 Aes：填写Aes认证所使用的密钥Key。 Public Key：填写Public Key认证所使用的公钥。 Secret
口仍要能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数
看API的详细信息。 获取API的调用凭据 需要付费购买的API（来源于华为云市场的API），可按照页面引导和提示，完成API购买，然后在“买家中心>已购买的服务”中看到商品信息，单击“资源详情”可查看API调用凭据（AppKey/AppSecret）。 不需要付费购买的API（
问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名唯一且不可更改，每天最多可以访问1000次。 独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。
安全：对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议，保障API的安全合规。 可用性：对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议，保障API的高可用性。 易用性：对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议，提升API调用者使用体验。
附录-API治理规范指导 概述 规范要求 工具平台
后端服务地址：后端服务的地址。 路径：后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面，定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时，返回的响应信息示例。 失败响应示例 调用API失败时，返回的响应信息示例。
默认为TCP协议。 检查端口 健康检查的目标端口。 缺省时为负载中主机的端口号。 正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值为2 ~ 10。缺省时为5。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
