检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号
HORIZER时,authorizer_id字段必须传入 auth_opt AuthOpt object 认证方式参数 cors Boolean 是否支持跨域 TRUE:支持 FALSE:不支持 缺省值:false match_mode String API的匹配方式 SWA:前缀匹配
介绍如何调用API(简易认证) 02:01 调用API(简易认证) API网关 APIG 介绍如何创建访问控制策略 01:52 创建访问控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) 最佳实践 API网关 APIG 在API网关上开放内网ELB中的服务
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
调用API 调用APIG开放的API 跨域调用APIG开放的API APIG的API响应消息头说明 APIG的API错误码说明
在左侧导航栏选择“API管理 > API列表”,单击“创建API > 创建API”。 根据下表参数,配置前端信息。 表4 前端配置 参数 配置说明 API名称 填写API名称。 所属分组 API所属分组,此处默认“DEFAULT”。 URL 请求方法:接口调用方式,此处选择“GET”。
流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制
怎样保护API的调用安全? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。
操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,例如“API01”。 所属分组 API所属分组,此处默认“DEFAULT”。
满足条件的记录数 apis Array of OrchestrationApiInfo objects 编排规则绑定的API列表。 表5 OrchestrationApiInfo 参数 参数类型 描述 api_id String API编号。 api_name String API名称。
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
查看API绑定的流控策略列表 功能介绍 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bin
检查APP是否授权访问API APIG.0305 Incorrect authentication information. 401 认证信息错误 检查认证信息是否正确 APIG.0306 API access denied. 403 不允许访问API 检查是否授权访问API APIG.0307
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG的实例规格
Long 满足条件的记录数 apis Array of PluginApiInfo objects 绑定插件的API列表。 表5 PluginApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称。 支持汉字、英文、数
的加密key。 app_api_key app_api_key认证方式开关,默认关闭。启用后,可在API请求中添加“apikey”参数,携带凭据的Key进行API的调用认证。 app_basic app_basic认证方式开关,默认关闭。启用后,在API请求中添加Header参数
使用iOS系统时,如何使用APP认证调用API? 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? 是否支持移动应用调用API? 部署在VPC下的应用是否可以调用API? APIG是否支持WebSocket数据传输? API的策略后端有多个时,怎么匹配和执行API请求?
只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。