检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码，状态码及对应的说明。 API响应参数说明包括Header参数，需要明确字段内容和取值范围。 API正常响应B
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则，可提升API的可用性。 在API发布之前，需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分：并发请求控制，吞吐量控制和传输流量控制。 并发请求控制：指API最大允许的客户端连接数量。
API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。 转义说明可参考：RFC
通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中，RDS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。 父主题： 安全
所有API。您在创建API前，需要先创建API分组。 目前支持两种创建分组方式： 创建API分组 创建一个简单的分组，不包含API，用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件，同步创建分组。 对外开放API时，您需要为API分组绑定自己的独立域名。
仅支持华为云账号修改服务商信息，不允许该账号下的IAM用户修改服务商信息。 商用 变更服务商信息 3 API中心支持网关白名单 如果需要使用API网关代理功能，需要在申请入驻中心服务商时告知运营人员。 商用 服务商入驻 2023年5月 序号 功能名称 功能描述 阶段 相关文档 1 支持取消服务商入驻
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API，用于系统集成和项目开发，请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索：输入您需要的API的一些关键信息，如API名称、描述等，系统会展示相关的搜索结果。
创建凭据并绑定API 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面。
API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正式发布接口变更公告，应当至
API网关代理默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API，在“安全配置”时，打开“支持跨域（CORS）”开关。详细的使用指导，可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“请求方法
仅在使用负载通道时，需要设置。选择已创建的负载通道名称。 后端服务地址（可选） 仅在不使用负载通道时，需要设置。 格式：“主机:端口”，主机为IP地址/域名，未指定端口时，HTTP协议默认使用80端口，HTTPS协议默认使用443端口。 端口范围：1 ~ 65535。 如果需要创建变量标识
API策略”。 在“策略管理”页面，单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型，策略内容的配置不同： 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后，您还需要为API绑定策略，才能使策略对API生效。 为API绑定策略
创建环境成功后，在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境，如果访问其他环境，需要在请求头中添加X-Stage头，内容为环境名。例如访问名为“DEVELOP”的环境，则添加“X-Stage:DEVELOP”。 管理控制台
下线API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
和“类型”配合使用，允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址，或IP地址范围。 仅在“类型”为“IP地址”时，需要设置。 说明： 允许或禁止访问的IP地址条数，分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名，仅在API的安全认证方式为“华为IAM认证”时适用。
务时，保障后端服务的安全。 签名密钥由一对Key和Secret组成，签名密钥需要绑定到API才能生效。当签名密钥绑定API后，API网关代理向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果和API网关代理传过来的Auth
授权”。 单击“添加授权”。 选择API授权环境，查询并勾选凭据后，单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权，在“授权历史”弹窗中，选择需解除授权的凭据，单击“操作”列“解除授权”。 父主题： API列表
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
选择API需要发布到的环境，并填写发布说明。 如果API在选择的环境中已发布，再次发布即为覆盖该环境的API。 如果在选择环境时，没有自己需要的环境，单击“创建环境”链接，创建一个自己需要的环境。 单击“确定”，完成API发布。 已发布的API因为其他原因需要暂停对外提供服务
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
