检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API网关不支持缓存数据加密,对于响应中的敏感数据存在安全风险,请谨慎配置策略。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 响应缓存策略原理图如下:
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
通过标签查询实例列表 功能介绍 通过标签查询实例列表 接口约束 使用策略授权用户时,需要包含apig:instance:listByTags的授权项才允许调用此接口. 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/resource-instances/filter
API、环境、凭据之间的关系? API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。 应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(凭据)后,
求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。
创建应用并获取授权 操作场景 使用APP认证的API,需要在API网关中创建一个应用,以生成应用ID和密钥对(AppKey、AppSecret)。将创建的应用绑定API后,才可以使用APP认证调用API。在API调用过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进
专享版API网关按实例版本费用+公网带宽费用计费。计费模式详情请参考表表1和表2。 实例版本详情请参考产品规格,实例版本价格详情请参考价格详情,每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买周期越长
包年/包月模式 对于包年/包月计费模式的实例资源,您在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订。 如果您
欠费说明 使用API网关服务时,您的账户可用额度小于待结算的账单,即被判定为账户欠费。欠费后,可能会影响服务资源的正常运行,请及时充值。 欠费原因 在按需计费模式下账户的余额不足。或者在包年/包月模式,带宽按需计费模式下账户的余额不足。 欠费影响 按需计费时,实例按秒计费,每一个
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发
功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
认证中使用该函数后端作为认证后端。 图1 前端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 自定义认证调用API 约束与限制 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 创建用于前端自定义认证的函数 在使用前端自定
作为认证函数,并在自定义认证中使用该函数后端作为认证后端。 图1 后端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 使用自定义认证调用API 约束与限制 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 创建用于后端自定义认证的函数
值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 configs Array of Config objects 配额列表 表5 Config 参数 参数类型 描述
ps_port同时使用默认端口,则两个参数都不填。 当修改域名时,该参数未填表示不修改该端口。 最小值:-1 最大值:49151 ingress_https_port Integer 访问该域名绑定的https协议入方向端口,-1表示无端口且协议不支持,可使用443默认端口,其他
API的后端服务是否支持绑定私网ELB地址? 专享版支持绑定私网ELB地址。 共享版不支持绑定私网ELB地址,请使用VPC通道。 如果是公网ELB地址,可直接使用。 父主题: 开放API
vpc_channel_status 否 Integer 是否使用VPC通道 1:使用VPC通道 2:不使用VPC通道 表11 ApiPolicyHttpCreate 参数 是否必选 参数类型 描述 url_domain 否 String 策略后端的Endpoint。后端服务不使用VPC通道时,参数必选 由域名
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径是否正确。 检查API是否发布。 检查域名解析是否正确。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请求,请在API中开启CORS。 具体操作请参见常见问题。 APIG.0101 The API
API管理”,进入到API管理信息页面。 单击“导入API”,进入“导入API”界面。 选择如表1所示参数。 图1 导入API 表1 导入API 参数名称 说明 导入方式 导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。