API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
API、环境、凭据之间的关系? API可以被发布到不同的环境中。比如RELEASE和BETA两个环境,分别代表线上和测试环境。 应用(凭据)指代一个API调用者的身份。创建应用(凭据)时,系统会自动生成用于认证该身份的应用(凭据)Key&Secret。将指定的API授权给指定应用(
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持apig实例节点访问日志上报功能。 是 {"name":"lts
创建用户并授权使用APIG 如果您需要对您所拥有的API网关服务进行权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以: 根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。如果不配置SSL证书,将无法保障请求的链路安全,请谨慎配置。 单向认证:客户端与服务端连接时
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到指定环境。 操作步骤 进入API网关控制台页面
克隆APIG的API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 克隆API
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 配置API的OIDC认证 父主题: 配置API策略
Go 操作场景 使用Go语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考调用API示例调用API。 本章节以IntelliJ IDEA 2022.2.1版本为例介绍。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Go安装包1.14或以上版本
使用IAM认证调用API Token认证 AK/SK认证
对后端服务进行签名 签名前准备 Java Python C#
PHP 操作场景 使用PHP语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装IntelliJ IDEA
Android 操作场景 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Android Studio 4.1.2或以上版本,如果未安装,请至Android
APIG安全最佳实践 安全性是华为云与您的共同责任。华为云负责云服务自身的安全,提供安全的云;作为租户,您需要合理使用云服务提供的安全能力对数据进行保护,安全地使用云。详情请参见责任共担。 本文提供了APIG使用过程中的安全最佳实践,旨在提供可操作的规范性指导以提升整体安全能力。依据该指导文档
调用API报“No backend available” 检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 >
怎样给指定的用户开放API? 可以采用以下两种方式: 创建API时可选取APP认证方式,AppKey和AppSecret分享给指定的用户。 使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 父主题: API策略