检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
只允许授权的访问。 签名密钥：API网关代理提供签名密钥，用于后端服务校验API网关代理是否合法。 访问控制 流量控制：API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。 访问控制：API网关代理支持通过设置IP地址或账户的黑白名单来禁
访问控制策略是API网关代理提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的，只有将访问控制策略绑定API后，访问控制策略才对绑定的API生效。 使用限制
本条规则是Should类型的扩展规则，可提升API的可用性。 在API的设计阶段需要对单位时间可处理的能力进行设计，指标包括吞吐量和并发量。 吞吐量（TPS）是指服务在单位时间内处理请求的数量，使用单位时间为秒。 并发量是指服务可以同时承载的正常使用系统功能的用户的数量。 服务API的最大吞吐量
负载通道主要用于将服务通过API网关代理开放给外部访问，它的优势在于使用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS
API。 选择API需要发布到的环境，并填写发布说明。 如果API在选择的环境中已发布，再次发布即为覆盖该环境的API。 如果在选择环境时，没有自己需要的环境，单击“创建环境”链接，创建一个自己需要的环境。 单击“确定”，完成API发布。 已发布的API因为其他原因需要暂停对外提
“类型”为“NUMBER”时，设置参数值的最大值。 最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“下一步”，进入后端配置。 后端配置 支持定
Generic Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
PI中心管理控制台的以下功能： API资产分享：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务。 A
资产名称 自定义API资产的名称。 说明： 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。
POST：请求方法，需替换为获取API的请求信息中获取的请求方法。 {Address}：请求地址，需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API，无需另外配置。 {Path}：请求路径，需替换为获取API的请求信息中获取的URL。 {Que
API次数的上限受增加特殊租户时设置的“阈值”限制，其他用户调用API次数的上限，仍然受本参数值限制。 凭据流量限制 单个凭据调用API次数上限，仅在API的安全认证方式为“APP认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用，表示“时长”时间内的凭据请求次数上限。
资产名称 自定义API资产的名称。 说明： 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。
资产名称 自定义API资产的名称。 说明： 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。
选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API，如果需要导出个别API，单击“自定义导出API”，勾选需要导出的API名称。 API定义范围 基础定义：只导出API前端定义。其中API前端定义除了Swagger规范定义项外，还包括API网关代理的一些Swagger扩展字段。
订阅成功后，鼠标放在“联系咨询”上面，就会显示服务商的电话和邮箱。您可以通过已获取的联系方式联系服务商，获取API的调用方式。 单击“已订阅”，可以取消订阅API。 获取API的调用凭据。 需要付费购买的API（来源于华为云市场的API），可按照页面引导和提示，完成API购买，然后在“买家中心>已购买的服务”中看到商
名访问分组内的API。 环境 为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般
API响应报文使用分页，避免超长列表数据返回 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时，返回HTTP状态码为“200”和Response信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。 后续操作
哪些API支持在线调测？ API中心服务商在上架API资产时，如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件，且提供了API资产的访问域名，则该API可以在线调测。 父主题： API网关代理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
