检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 约束与限制 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。
查询分组自定义响应详情 功能介绍 查询分组自定义响应详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/
获取异步任务结果 功能介绍 获取异步任务结果。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述
更新VPC通道后端服务器组 功能介绍 更新指定VPC通道后端服务器组。当负载通道为nacos微服务类型时,不支持修改服务器组权重。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果
配置APIG专享版与客户端间的单向认证或双向认证 应用场景 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略在当前实例中不支持
授权项变更公告 公告说明 自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。 权限描述 对应的API 新增授权项 依赖授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET /
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后
专享版-环境管理 创建环境 修改环境 删除环境 查询环境列表 父主题: 专享版API(V2)
专享版-标签管理 查询标签列表 父主题: 专享版API(V2)
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
专享版-设置特殊流控 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 专享版API(V2)
环境管理 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 共享版API(仅存量用户使用)
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出