检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节： 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节： 约束与限制 2023-05-22 第六次正式发布。 新增如下章节： 图解API中心 优化如下章节： 产品优势 2023-03-31
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节： 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节： 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节： 生产API
修订记录 发布日期 修订记录 2023-07-14 第九次正式发布。 优化如下章节： 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节： 取消入驻服务商 优化如下章节： 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。
修订记录 发布日期 修订记录 2023-05-06 第四次正式发布。 新增如下章节： 服务商入驻成功后可以取消入驻吗？ 服务商入驻成功后信息还可以修改吗？ 2023-04-10 第三次正式发布。 优化如下章节： 为什么要申请入驻服务商？ 申请入驻API中心服务商有哪些入口？ 服务商入驻审核多久通过？
（可选）如果API分组中的API支持HTTPS请求协议，则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“添加SSL证书”。 根据下表参数信息，配置SSL证书。 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法，推荐您使用ECDSA和DSA加密算法。
API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。
支持回滚到不同的API历史版本。 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建环境。 发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。
环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道，每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率 不大于200次/秒。 特殊应用 每个流控策略最多可以创建30个特殊应用。
访问环境 通过RESTful API可以访问API默认的RELEASE环境，如果访问其他环境，需要在请求头中添加X-Stage头，内容为环境名。例如访问名为“DEVELOP”的环境，则添加“X-Stage:DEVELOP”。 管理控制台的“调试”功能，固定为调试环境，不支持携带环境变量调试。
上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据，或已获取其他用户的凭据ID。 在流控策略详情页面，单击“特殊应用”页签，进入特殊应用页面。 单击“添加特殊应用”，弹出“添加特殊应用”对话框。 通过以下两种方式，添加特殊应用。 添加已有应用：单击“已有应用”，选择已有凭据名称，输入阈值。
原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，必须将API修订的记录按照时间和版本顺序排列进行条目化，具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15
在API请求中添加Header参数“X-HW-ID”，参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API的认证信息中获取到的Secret。 APP认证（app_basic认证） 在API请求中添加Heade
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量。例如创建API时定义了变量名为“Path”，在环境1中创建了变量名“Path”，变量值“/Stage/test”，则API在发布到环
本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，POST请求是向指定的资源提交要被处理的数据，其响应不会被缓存；PUT请求用来提交数据时，其响应是不能被缓存的。 父主题：
例如，请求路径为/test/AA，使用前缀匹配时，通过/test/AA/CC可以访问，但是通过/test/AACC无法访问。 标签 标签主要用于对API添加分类属性，方便在创建了大量API后，快速过滤和查找。 描述 API的描述。 根据下表参数信息，配置安全配置。 表3 定义API请求 参数 配置说明
单击分组名称，在“API运行”页面，选择待删除的API，单击“删除”。 说明： API先下线，才能删除。 为API添加策略 单击分组名称，在“API运行”页面，选择待添加策略的API，单击“添加策略”。具体参数配置，参考创建策略章节。 将分组内已发布的API上架至门户网站 任选以下三种方式之一
请求参数中未定义请求参数，可直接跳过此步骤。 在“后端服务参数”下，可通过以下任意一种方法添加后端服务参数。 单击“导入入参定义”，把所有已定义的API请求参数添加到后端服务参数。 单击“添加后端参数映射”，按需逐个添加后端服务参数。 根据后端服务实际的参数名称和参数位置修改映射关系，如图1所示。
中看到该API资产。 私有：创建API资产成功后，仅创建该API资产的用户能在API中心门户网站中看到该API资产。 标签 为该API资产添加个性标签，方便用户通过标签了解API资产的特点。 填写完API资产信息后，单击“立即创建”。 等待系统解析API文件。API资产所在行“状
中看到该API资产。 私有：创建API资产成功后，仅创建该API资产的用户能在API中心门户网站中看到该API资产。 标签 为该API资产添加个性标签，方便用户通过标签了解API资产的特点。 填写完API资产信息后，单击“立即创建”。 等待系统解析API文件。API资产所在行“状
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
