"/users" timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 address 是 Array 后端服务地址,格式为:<域名或IP>:[port]。 scheme 是 String 后端请求协议定义,支持http、https。 method 是 String
env_id 否 String 发布的环境编号 plugin_name 否 String 插件名称 plugin_id 否 String 插件编号 env_name 否 String 环境名称 plugin_type 否 String 插件类型 请求参数 表3 请求Header参数 参数
本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 SYS.APIC 监控指标 表1 监控指标说明 指标ID 指标名称 含义 取值范围 测量对象&维度 监控周期(原始指标)
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。
项。 如表1所示,包括了API网关的所有系统角色和策略。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 如果
单击待查看的API分组名称,进入此分组详情页面。 查看此分组下已购买的API列表和此分组的详细信息。 图2 已购买API的分组详情示例 在待调试API所在行,单击“调试API”,跳转到“调试API”页面。 左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。
APIG专享版支持单向认证和双向认证两种认证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。
API调用次数超出所配置的流量策略阈值 应用未授权 401 使用的应用未被授权访问该API API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.appId API调用者的APP对象ID $context.requestId
能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
关键操作通知 查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 删除API分组 ApiGroup
在左侧导航栏选择“实例管理”。 在待添加标签的实例上,单击“查看控制台”或实例名称。 在“标签”页签中,单击“添加标签”。 标签由键和值组成,值可以为空。 标签键:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = + - @字符; _sys_开头属于系统标签,租户不能输入。
zip等多种因素影响。下表是API网关处于30%CPU水位下的QPS参考值,参考场景为无认证和单机流控模式。 安全水位指能够在突发流量增长至双倍的情况下,API网关系统依然维持高吞吐量和低延迟性能。 表1 QPS性能参考 实例规格 基础版 专业版 企业版 铂金版 铂金版x2 连接类型
略。 创建新策略:请参考表1所示配置策略。 表1 配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。
计费模式概述 专享版API网关 专享版API网关按实例版本费用+公网带宽费用计费。计费模式详情请参考表表1和表2。 实例版本详情请参考产品规格,实例版本价格详情请参考价格详情,每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模
单击待操作的分组名称,进入分组详细信息页面。单击“变量管理”。 在待创建环境变量的分组所在行,单击“更多 > 变量管理”。 在“环境”中选择待添加变量的环境名称,单击“添加变量”,弹出“新增变量”对话框。 填写如表2所示信息。 图3 新增变量 表2 新增变量 信息项 描述 变量名称 变量的
创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看key和Secret。 绑定API/授权API 绑定API或授权API就是将API与凭据关联起来,APIG可以根据凭据的密钥对进行身份鉴权,调用关联的API。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。
应用信息。 表1 应用信息 信息项 描述 应用名称 应用名称。 描述 对应用的介绍。 单击“确定”,创建应用。 创建应用成功后,在“应用管理”页面的列表中显示新创建的应用和应用ID。 单击应用名称,进入应用详情页面,查看AppKey和AppSecret。 图1 应用详情 绑定API
在左侧导航栏选择“API管理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,根据下表参数说明,填写环境信息。 表1 环境信息 参数 说明 环境名称 API环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。 描述 环境描述信息。长度为1-255个字符。 单击“确定”,创建环境。
I网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API 表1 导出API 参数名称 说明 API分组 选择待导出API所在的API分组。
认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。
您即将访问非华为云网站,请注意账号财产安全