检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
IAM认证信息错误 IAM认证信息错误有: Incorrect IAM authentication information: verify aksk signature fail Incorrect IAM authentication information: AK access
计费模式概述 专享版API网关 专享版API网关按实例版本费用+公网带宽费用计费。计费模式详情请参考表表1和表2。 实例版本详情请参考产品规格,实例版本价格详情请参考价格详情,每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
包年/包月 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。 导入API设计文件 从本地导入已有的API文件,同步创建分组。
导出API 导出JSON、YAML或YML格式的API。API网关支持单个API导出和批量API导出。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理
创建用于前端自定义认证的函数 操作场景 如果您想要使用自己的认证系统对API的访问进行认证鉴权,您可以在API管理中创建一个前端自定义认证来实现此功能。在使用前端自定义认证对前端请求进行认证鉴权前,您需要先在FunctionGraph创建一个函数,通过函数定义您所需的认证信息。函
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 导入到新分组注意事项 将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。
实施步骤 前提条件 已创建自定义认证函数,如果未创建请参考《函数工作流用户指南》中的创建函数章节创建,并且在函数的返回值中已设置context字段,字段中包含键值对。其中键值对的值只支持字符串、布尔、整型三种数值类型,键值对对应“系统参数-前端认证参数”策略条件的参数名称和条件值。
C++ 操作场景 使用C++语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install
C 操作场景 使用C语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev 安装curl库。 apt-get install
怎样保护API? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API
错误码 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
操作流程 准备CCE工作负载信息 在通过API网关将容器的工作负载对外开放前,需要在云容器引擎控制台创建CCE集群(VPC网络模型)或Turbo集群。 开放CCE工作负载 方式一:在API网关中直接创建负载通道并开放API,通过负载通道访问CCE工作负载中的实例地址。 方式二:在
发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同
变更实例规格 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。 当前支持ELB类型的实例规格变更,除墨西哥城一、北京一区域外,其他区域都支持规格变更。规格变更过程中,长连接会发生闪断,需要重新建链,建议业务低峰期进行规格变更。 只能升配到更高规格,无法降配规格。
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示。
查看或编辑实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,查看或编辑实例的配置信息。 表1 实例信息 可编辑项 说明 基本信息
创建自定义认证 功能介绍 创建自定义认证 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1 路径参数 参数 是否必选 参数类型 描述 project_id