检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
API网关可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: API创建
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
失败,账号将变成欠费状态,华为云将通过邮件、短信和站内信的方式通知您。 欠费后,按需实例不会立即停止服务,资源进入宽限期。您需支付按需实例在宽限期内产生的费用,相关费用可在华为云控制台的“费用 > 费用账单 > 总览”页面的“欠费金额”查看,华为云将在您充值时自动扣取欠费金额。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
选择授权环境,勾选API,单击“绑定”,完成API绑定策略。 绑定成功后,可以在应用详情页面查看已绑定的API。 只有APP认证的API才可以被应用绑定。 一个应用可以绑定多个APP认证的API,一个APP认证的API也可以绑定多个应用。 如果需要调试已绑定的API,单击“调试API”,进入调试页面。
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
跨域资源共享策略:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。 流量控制2.0策略:可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。 Kafka日
选择授权环境、API分组和API。 单击“确定”。 如需解绑API,在API所在行单击“解绑”即可。 一个凭据可以绑定多个APP认证的API,一个APP认证的API可以绑定多个凭据。 父主题: 凭据管理
使用者,推荐该方式。 适用于API需求波动的场景,可以随时开通,随时删除。 当您的API后端服务部署在公网时,除实例费用外需要另外收取API请求出公网带宽费用。 专享版实例部署在虚拟私有云中,如果您的后端服务也部署在相同虚拟私有云,可直接通过私有地址访问,无需购买带宽。 专享版实
创建用于后端自定义认证的函数 操作场景 如果您需要使用一种认证机制对接多个不同的外部认证系统,实现对于后端服务的保护,您可以通过API网关中的后端自定义认证实现此功能。在使用后端自定义认证对后端请求进行认证授权前,您需要先在FunctionGraph创建一个函数,通过函数定义您所
在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。 后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 使用API方式创建环境 您还可以使用API的方式创建环境和变量,具体操作请查看以下链接。 创建环境 新建变量 环境变量相关的FAQ
方案概述 应用场景 API网关提供了灵活的安全认证方式,用户可以配置自定义认证实现API的双重认证方式。本文以API前端认证使用APP认证和自定义认证(双重认证)结合场景为例,具体说明如何创建使用双重认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,
API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。您也可以通过关闭“调试域名开关”来关闭调试域名,关闭后将隐藏调试域名,且不能通过调试域名调用API。 实例创建后,有一个DEFAULT分组,可直接通过虚拟私有云地址调用默认分组中的API。 前提条件 已创建实例。
配置参数 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。
在这个时间段内,运维人员可以对该实例的节点进行维护操作。维护期间,业务可以正常使用,可能会发生闪断。维护操作通常几个月一次。 maintain_end 否 String 维护时间窗结束时间。时间格式为 xx:00:00,与维护时间窗开始时间相差4个小时。 在这个时间段内,运维人员可以对该实例的
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开
None 操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用API(简易认证)
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开