检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订。
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。
配置API的自定义认证:您可以通过自定义认证来自定义认证系统。 配置API的参数编排规则:您可以通过不同算法规则,将请求参数映射为新的请求参数。 自定义API的错误响应信息:您可以通过网关响应功能,自定义响应状态码或网关响应内容。
在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。
独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
(可选)设置系统参数。 系统参数指API网关服务处理API请求时的系统运行时参数信息,包括网关内置参数、前端认证参数、后端认证参数等,API的后端服务获取到这些信息,可以用于做一些辅助性的访问控制或提供自定义认证能力。 在“系统参数”右边单击,显示系统参数列表。
您可以在控制台的“费用中心 > 总览”页面设置“可用额度预警”功能,当可用额度、通用代金券和现金券的总额度低于预警阈值时,系统自动发送短信和邮件提醒。 当产生欠费后,请您及时充值使可用额度大于0。
RELEASE系统环境不能删除;如果环境上存在已发布的API,需要先下线API才能删除环境。删除后将无法恢复,请谨慎操作。 用户调用开放的API时,默认是调用RELEASE环境的API。
其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。 图1 自定义认证函数 已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。
用户权限 如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略,则拥有“APIG FullAccess”即可。
前提条件 给用户组授权之前,请您了解用户组可以添加的APIG权限,并结合实际需求进行选择,APIG支持的系统权限,请参见角色与策略权限管理。如果您需要对除APIG之外的其它服务授权,IAM支持服务的所有权限请参见系统权限。
系统默认包含reqPath(请求路径)和method(请求方法)参数。单击“添加参数”,可添加其他匹配参数。 定义规则 自定义断路器的匹配规则。单击“添加规则”,可添加规则,系统根据从上到下的顺序匹配规则,可通过上下移动调整规则优先级。 匹配条件:单击“”编辑匹配条件表达式。
两者有如下的区别和关系: 表1 两类授权的区别 名称 核心关系 涉及的权限 授权方式 适用场景 角色与策略授权 用户-权限-授权范围 系统角色 系统策略 自定义策略 为主体授予角色或策略 核心关系为“用户-权限-授权范围”,每个用户根据所需权限和所需授权范围进行授权,无法直接给用户授权
该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 type 否 Integer 流控策略的类型 1:基础,表示绑定到流控策略的单个API流控时间内能够被调用多少次。
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题 API是否已发布。
多语言SDK API网关为客户端提供Java、Go、Python、C等多语言的SDK接入,业务后端无需做修改,轻松实现一套系统对接多种业务场景(如移动场景、IoT场景等)。
系统参数 响应头的类型。 自定义参数:自定义内容作为响应头的value。 系统参数:使用系统参数作为响应头的value。 Value 响应头的值。当“Action”为“Delete”时响应头的值不生效,可为空。长度为1-255字符。
无法添加API网关增加的系统响应头(x-apig-*,x-request-id等)。 表2 PluginProxyCacheKey 参数 是否必选 参数类型 描述 system_params 否 Array of strings 使用网关内置系统参数作为响应缓存键值。
该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。
表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名