检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
开放API 开放API流程 创建API分组 添加API的SSL证书(可选) 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
查看APIG的带宽监控 API网关支持查看出入口带宽各项指标的监控数据。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变
专享版-实例自定义入方向端口管理 查询实例指定的自定义入方向端口绑定的域名信息 查询实例的自定义入方向端口列表 新增实例的自定义入方向端口 删除实例指定的自定义入方向端口 父主题: 专享版API(V2)
API策略 是否支持对API的请求并发次数做控制? 企业账号是否有调试域名每天最多可以访问1000次的限制? API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
实施步骤 前提条件 已创建自定义认证函数,如果未创建请参考《函数工作流用户指南》中的创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
开放API 无法创建API是什么原因? API的响应码如何定义? API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? APIG是否支持多后端节点方案? API可以绑定内网域名吗? 为什么跨域调用API失败? API网关如何开放部署在华为云上的服务
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束说明 创建实例存在一些约束,当您登录后无法创建实例,或者创建失败,请参考以下约束说明进行检查,并解除限制。 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例
查看版本详情 功能介绍 查询某个指定的版本详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK
专享版API(V1)(待下线) 使用限制 API分组管理(待下线) API管理(待下线) APP管理(待下线) APP授权管理(待下线) 环境管理(待下线) 环境变量管理(待下线) 流控策略管理(待下线) API绑定流控策略(待下线) 设置特殊流控(待下线) ACL策略管理(待下线
查询API详情 功能介绍 查看指定的API的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
获取SSL证书列表 功能介绍 获取SSL证书列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目
授权项变更公告 公告说明 自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。 权限描述 对应的API 新增授权项 依赖授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET /
实施步骤 登录函数工作流控制台,在“总览”页面,单击“创建函数”。详情请参考使用FunctionGraph服务实现APIG的自定义认证。 根据下表,填写函数信息后,单击“创建函数”。 表1 函数信息配置 参数 配置说明 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目