检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则，可提升API的可用性。 在API发布之前，需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分：并发请求控制，吞吐量控制和传输流量控制。
API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(offset)。
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则，可保障API租户的业务连续性。 对于需要下线的API，需要梳理订阅该API的用户，并通过公告等方式向订阅API的用户进行提醒。
建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。
包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API，Should规则在提供更全面指导的基础上，给予开发者灵活的弹性空间，方便开发者更快地加入API生态圈。
图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。
建议您按照一定的命名规则填写API名称，方便您快速识别和查找。 所属分组 API所属的分组。可以选择已有分组，或者单击右侧的“新建分组”链接，新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。
建议您按照一定的命名规则填写SSL证书名称，方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件（后缀名为“.pem”），将证书内容复制到“证书内容”中即可。
仅在“类型”为“IP地址”时，需要设置。 说明： 允许或禁止访问的IP地址条数，分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名，仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时，需要设置。
访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API，保护后端服务。 父主题： 安全
如果想要设置之前版本为当前版本，则在版本所在行，单击“切换至此版本”，弹出“切换至此版本”对话框。 单击“确定”，完成版本的切换。此时版本号旁边括号里显示“当前版本”，说明设置成功。API调用者调用此API时，API参数以“当前版本”设置的参数值为准。
正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定负载通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值为2 ~ 10。缺省时为5。 超时时间 检查期间，无响应的时间，单位为秒。
需根据获取API的请求信息中获取的请求参数进行设置。 {Header}：请求头参数，格式为“参数名: 参数取值”，例如Content-Type: application/json。需根据获取API的请求信息中获取的Headers进行设置。 {Body}：请求消息体，JSON格式。
图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。
单击页面右上角的“导出API”，设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
增加特殊租户后，此用户调用API次数的上限受增加特殊租户时设置的“阈值”限制，其他用户调用API次数的上限，仍然受本参数值限制。 凭据流量限制 单个凭据调用API次数上限，仅在API的安全认证方式为“APP认证”时适用。 不能大于“API流量限制”的值。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
