检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
参数位置:用于规则匹配的参数位置。 path:API请求的URI,系统默认配置。 method:API请求方法,系统默认配置。 Header:请求头的key值。 说明: 建议不要设置敏感信息,以防泄露。 Query:QueryString的key值。 System:系统参数。 参数:用于判断与规则匹配中的参数值是否匹配。
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数
会监测微服务下所有在线实例的地址变化,并更新到负载通道中。 前提条件 已创建CSE微服务。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CSE微服务”。根据下表参数说
查看或编辑APIG的API信息 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理 > API列表”,进入到API列表页面。
告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面的“监控视图”区域,单击
手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“更多 > 克隆”。
实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相关ACL策略限制了API网关实例与后端服务所在子网的通信。 如果使用VPC通道,检查VPC通道业务端口、健康检查端口、后端服务器添加是否均正常。 如果VPC通道类型为微服务,检查APIG实例是否添加路由。详细操作请参见负载通道章节。 共享版APIG后端不支持配置内网ELB。
单个凭据最多同时授权1000个API。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,选择待授权的API,单击“更多
保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“访问控制策略”区域,单击“绑定”。
使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击API分组名称,进入API分组详情页面。 单个下线API
apig:instances:get √ √ 范围 全部Region。 影响 自定义策略中未包含以上新增的授权项时,用户无权访问以上API。 适配方案 创建或更新自定义策略,添加以上新增的授权项以及依赖授权项,并通过给用户组授予自定义策略来进行精细的访问控制。自定义策略请参考API网关自定义策略。
使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。 表1 错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or has not been published in the environment
表1 VPC通道配置 信息项 描述 通道名称 自定义VPC通道名称,用于识别不同的VPC通道。 端口 VPC通道中主机的端口号,即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器成员类型。成员类型在负载通道创建后将不能修改。 实例:通过选择弹性云服务器的方式添加负载通道成员。
api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 user_call_limits 否 Integer
于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和后端服务之间通信的合同。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“创建API > 创建GRPC
api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 type 否 Integer 流控策略的类型 1
API网关支持查看出入口带宽各项指标的监控数据。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表,配置监控信息。 表1 监控信息 参数 配置项 带宽IP
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
对后端服务进行签名 签名前准备 Java Python C#