检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
api_id 否 String API编号 api_name 否 String API名称 tags 否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调用方法 请参见如何调用API。 URI POST /v2/{
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略值,支持一个或多个值,使用英文半角逗号分隔 entity_type String ACL策略约束对象。取值范围: IP DOMAIN (租户名称) 请求消息样例:
PI免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。 同一个API发布到不同的环境可以绑定不同的流控策略;一个API在发布到特定环境后只能绑定一个默认的流控策略。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
Api swagger文档不存在 检查swagger文档是否存在 404 APIG.3092 The ECS does not exist. 弹性云服务器不存在 弹性云服务器被删除或者传入的ID错误 404 APIG.3094 Instance task does not exist
在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。 后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 使用API方式创建环境 您还可以使用API的方式创建环境和变量,具体操作请查看以下链接。 创建环境 新建变量 环境变量相关的FAQ
API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略;一个API在发布到特定环境后只能绑定一个默认的流控策略。 调用方法 请参见如何调用API。 URI POST /v2/
PI免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。 同一个API发布到不同的环境可以绑定不同的流控策略;一个API在发布到特定环境后只能绑定一个默认的流控策略。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
请求Body参数 参数 是否必选 参数类型 描述 sl_domain_access_enabled 是 Boolean 设置调试域名是否可以访问,true为可以访问,false为禁止访问 缺省值:true 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
成本优化 API网关(APIG)专享版提供基础版、专业版、企业版、铂金版等多个实例规格版本,每个规格对应不同的官网价。不同规格差异体现为每秒最大请求数、带宽、内网每秒新建连接数等,详情请参考产品规格。 用户可以根据自己的业务场景选择合适的APIG专享版规格,在此做如下推荐: 如果用
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供
了解更多常见问题、案例和解决方案 热门案例 API网关有哪些配额,是否可以调整? 流控策略怎么设置? APP认证和IAM认证有demo吗? AK SK鉴权如何使用? 有没有API导入示例? API的后端地址是否可以绑定为ELB地址? 如何创建API? 更多 开放API API的响应码如何定义?
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls[
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{proj
http_code 否 String 检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 protocol = http时必选
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。