检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
API,只是将新增的API导入分组。 扩展覆盖 勾选后,当导入API的扩展定义项名称(流控,访问控制,插件等)与已有的策略(流控,访问控制,插件等)名称相同时,会覆盖已有的策略(流控,访问控制,插件等)。 是否覆盖 勾选后,当导入API的名称与已有API的名称相同时,导入的API会覆盖已有的API。
理的一些Swagger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。
如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
优化服务商入驻 仅支持华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 商用 服务商入驻 2 优化变更服务商信息 仅支持华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 商用 变更服务商信息 3 API中心支持网关白名单 如果需
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
重置Secret Key唯一且不可重置,Secret支持重置。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。
API. 检查APP是否授权访问API。 401 APIC.0305 Incorrect authentication information. 检查认证信息是否正确。 403 APIC.0306 API access denied. 检查是否授权访问API。 401 APIC.0307
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。
PI描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。 基于已获取到的API调用凭据,
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数 X-Apig-RateLimit-app