检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括： 密码、AK/SK、Token等身份凭据。 密钥。 个人信息，如身份证号码、银行卡信息、家庭住址、健康信息等。 人与人之间的私人消息，如短信、电话通信内容。
源IP地址，为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端服务，一个API共可以定义5个策略后端。 定义默认后端。 添加策略后端前必须定义一个默认后端，当不满足任何一个策略后端的API请求，都将转发到默认的API后端。 在“后端配置”页面，选择API后端服务类型。
环境管理 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”，填写环境信息。 表1 环境信息 信息项
每个分组最多可以绑定5个独立域名。 API数量 每个用户最多可以创建200个API。 后端策略数量 每个API最多可以创建5个后端策略（不包含默认后端策略）。 凭据数量 每个用户最多可以创建50个凭据。 流量控制策略数量 每个用户最多可以创建15个流量控制策略。 签名密钥策略数量 每个用户最多可以创建5个签名密钥。
自定义配置AppKey和AppSecret。AppKey是身份标识，需要保证全局唯一。 如果没有特殊需求，不建议使用“自定义配置”，系统会默认生成全局标识，可在凭据详情中查看。 单击“确定”，创建凭据。 创建凭据成功后，在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称，进入详情页面，查看Key和Secret。
API发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API，该子域名每天最多可以访问1000次。 前提条件 在调用API前，确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
使用限制 同一个环境中，一个API只能被一个签名密钥绑定，一个签名密钥可以绑定多个API。 使用流程 图1 签名密钥流程图 在API中心管理控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关代理将签名后的请求发送到后端服务，此时Authorization头中包含签名信
单击页面右上角的“导出API”，设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API，如果需要导出个别API，单击“自定义导出API”，勾选需要导出的API名称。 API定义范围
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(offs
间。 禁止在API请求中携带超长报文体 本条规则是MUST类型的基本规则，可保障API的高可用性。 API通道默认请求报文体长度（Body Size）限制为2MB，默认请求Header长度（Header Size）限制为1MB。 明确API吞吐量与并发量 本条规则是Should类型的扩展规则，可提升API的可用性。
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
仅在请求消息头包含X-Apig-Mode: debug，且API配置了源IP流量限制时，返回此参数 X-Apig-RateLimit-api-allenv API默认流控信息 示例：remain:199,limit:200,time:1 second 仅在请求消息头包含X-Apig-Mode: debug时，返回此参数
每个凭据最多可创建5个AppCode。 生成APPCode 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面，单击凭据名称，进入详情页面。 在“AppCodes”区域，单击“添加AppCode”。 在弹窗中配置AppCode，完成后单击“确定”。
更服务商信息，然后联系API中心运营人员开通此功能。 等待审核。5个工作日内完成审核。您可以登录API中心管理控制台，查看审核进展。 审核通过后，您登录API中心管理控制台，就可以看到API资产管理等菜单了。 创建API资产 选择左侧导航栏中的“API资产管理 > API资产”。
访问方式 API中心分为API门户和管理控制台。 API门户的访问方式：通过浏览器（推荐Chrome）直接访问API中心门户网站，支持用户免登录情况下查看和搜索API。 管理控制台的访问方式：通过浏览器（推荐Chrome）使用API中心管理控制台方式进行API资产管理、API注册到网关等。
API名称 系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTPS”。 子域名：创建API分组时，系统默认分配的一个子域名。
API网关注册 API搜索和查找 API订阅管理 API数据分析 服务商入驻 支持华为云企业用户申请入驻成为API中心服务商，然后使用API中心管理控制台的以下功能： API资产分享：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：
为什么要申请入驻服务商？ API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代理包括API的
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
