检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 欢迎使用API网关(API Gateway),API网关为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。 您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用A
后端服务地址 仅在不使用负载通道时,需要设置。 填写后端服务的访问地址,格式:“主机:端口”。主机为后端服务的访问IP地址/域名;端口为后端服务的端口。未指定端口时,GRPC协议默认使用80端口,GRPCS协议默认使用443端口。 如果后端服务地址中需要携带环境变量,则使用“#变量名#”
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
灵活的策略路由 支持配置不同的后端,按照多种策略进行匹配转发,轻松解决企业应用的灰度发布,环境管理等难题。 多语言SDK API网关为客户端提供Java、Go、Python、C等多语言的SDK接入,业务后端无需做修改,轻松实现一套系统对接多种业务场景(如移动场景、IoT场景等)。
应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。 获取认证签名所使用SDK: 在API网关共享版控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 获取AppCode: 在API网关共享版控制台选择“调用API > 应用管理”,
已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret,请参见签名前准备获取。 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已安装Python安装包2
API后,使用APP认证调用API。 获取SDK 可通过SDK对AK/SK生成签名,并调用API。 调用API 通过获取API及API访问地址,调用API。根据API使用认证方式的不同,调用API时需要进行不同的认证鉴权操作。 父主题: 共享版操作指导(仅存量用户使用)
已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret,请参见签名前准备获取。 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已获取apigatew
已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已安装Visual Studio 2019 version 16.8.4或以上版本,如果未安装,请至Visual
在开始使用之前,请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以在SDK中心查询版本信息。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python hua
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
使用IAM认证调用API Token认证 AK/SK认证
线,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用),其余为专享版功能操作指导章节。 使用流程 使用API网关进行API的托管流程如下图所示。 图1 业务使用流程 创建用户并授权使用APIG 通过IAM服务创建用户并授权使用API网关,如果系统预置
将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请求中,或者作为查询字符串参数添加到HTTP请求中。
创建用户并授权使用APIG 如果您需要对您所拥有的API网关服务进行权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可以: 根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
X-Sdk-Date:请求发送的时间,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 Authorization:签名认证信息,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充
API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API,无需另外配置。 使用IP调用DEFAULT分组的API API允许使用IP地址调用DEFAULT分组下的API,无需另外配置。 使用IP调用非DEFAULT分组的API 使用IP地址直接调用非
AK/SK既可以使用永久访问密钥中的AK/SK,也可以使用临时访问密钥中的AK/SK,但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段,字段值为临时访问密钥的security_token。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请
证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,对来自APIG转发的后端服务请求进行安全认证。 本章节主要介绍如何创建