检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称。
}) } return json.dumps(resp) 配置测试事件并调试代码,然后部署。 在下拉框中选择“配置测试事件”并配置。将以下代码设置为测试事件。测试事件的参数值与环境变量中的参数值需要保持一致。 { "headers":
创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API
debug,且API配置了API流量控制时,返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
debug,且API配置了API流量控制时,返回此参数。 X-Apig-RateLimit-user 用户流量限制信息。 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts","enable":true
在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CSE微服务”。根据下表参数说明,配置信息。微服务引擎详细介绍请参考微服务引擎CSE。 表1 配置信息 参数 说明 所属分组 CSE微服务导入成功后,生成的API所在的API分组。支持同步创建新的分组或选择已有分组。
bind_num Integer 流控绑定的API数量 is_inclu_special_throttle Integer 是否包含特殊流控配置 1:包含 2:不包含 create_time String 创建时间 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code
无法找到插件配置 联系技术支持 APIG.0105 The backend configurations do not exist. 500 无法找到后端配置 联系技术支持 APIG.0106 Orchestration error. 400 编排错误 检查API配置的前后端参数是否合理
分组下指定错误类型的自定义响应,删除分组指定错误类型的自定义响应配置。 标签管理 包括标签列表的查询。 实例特性管理 包括实例特性的配置,查看实例特性列表。 配置管理 包括查看某实例的租户配置列表,查询租户实例配置列表。 实例管理 包括: 实例的创建、更新、查看、删除,查看实例创建进度,查询实例列表。
非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现,选择其中一种配置即可。 方式一:配置一个OPTIONS请求,作为预检请求。预检请求API的参数设置,操作详情请参考非简单请求。 方式二:只需配置一个跨域资源共享策略并绑定API即可,配置详情请参考配置API的跨域资源共享。 在“前端定义”中,参数填写说明如下:
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
使用iOS系统时,如何使用APP认证调用API? 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? 是否支持移动应用调用API? 部署在VPC下的应用是否可以调用API? APIG是否支持WebSocket数据传输? AP
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CCE工作负载”。根据下表参数说明,配置信息。 表1 配置信息 参数 说明 所属分组 CCE工作负载所属分组。支持同步创建新的分组或选择已有分组。 集群 选择集群,可单击“查看云容器引擎CCE”查看。
致API缺少公网访问的有效地址,公网调用API失败。 绑定EIP后重新调用即可,详细步骤请参考网络环境准备。 入方向规则配置有误,导致公网调用API失败。 配置入方向规则的详细步骤请参考网络环境准备。 调用时未添加请求消息头“host:分组域名”,导致公网调用API失败。添加消息头后,重新调用即可。
云审计服务 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 APIG用户查看云审计日志方法,请参见云审计日志。 日志 APIG支持日志自定义分析模板,便于日志的统一收集和管理,也可通过API异常调用分析进行追查和溯源。 关于APIG日志记录的详细介绍和配置方法,请参见日志分析。 父主题: