- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
-
更多文档
-
用户指南(吉隆坡区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 克隆API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- 支持HTTP2.0
- API策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(吉隆坡区域)
-
API参考(吉隆坡区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(阿布扎比区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 导入CCE工作负载
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 创建GRPC API
- 克隆API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- 支持HTTP2.0
- API策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(阿布扎比区域)
-
API参考(阿布扎比区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
- 最佳实践(阿布扎比区域)
- 用户指南(巴黎区域)
- 开发指南(巴黎区域)
- API参考(巴黎区域)
-
用户指南专享版(巴黎区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- API策略
- 凭据管理
- 监控分析
- 实例管理
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南专享版(巴黎区域)
-
API参考专享版 (巴黎区域)
- 使用前必读
- 如何调用API
- 专享版API(V2)
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(吉隆坡区域)
- 通用参考
链接复制成功!
认证鉴权
调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。
- Token认证:通过Token认证调用请求。
- AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
Token认证
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
在构造请求中以调用创建API分组(专享版API)接口为例说明了如何调用API。获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。
POST https://{apig_endpoint}/v1.0/apigw/api-groups Content-Type: application/json X-Auth-Token: ABCDEFJ....
AK/SK认证
通过使用Access Key ID(AK)/Secret Access Key(SK)加密的方法来验证某个请求发送者身份。当您使用AK/SK认证方式完成认证鉴权时,需要通过请求签名流程获取签名并增加到业务接口请求消息头。
AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
以下结合一个Demo来介绍如何对一个请求进行签名,并通过HTTP Client发送一个HTTPS请求的过程。
Demo下载地址:https://github.com/api-gate-way/SdkDemo
如果您不使用Demo工程,也可以直接向技术支持获取API网关签名工具在其他工程中引用。
解压下载的压缩包,得到一个jar文件。将解压出来的jar文件引用到依赖路径中。如下图所示:

- 生成AK/SK。如果已生成过AK/SK,则可跳过步骤1,找到原来已下载的AK/SK文件,文件名一般为:credentials.csv。
- 注册并登录管理控制台。
- 将鼠标移至用户名,单击用户名,在下拉列表中单击“我的凭证”。
- 单击“管理访问密钥”。
- 单击“新增访问密钥”,进入“新增访问密钥”页面。
- 输入当前用户的登录密码。
- 通过邮箱或者手机进行验证,输入对应的验证码。
说明:
在统一身份服务中创建的用户,如果创建时未填写邮箱或者手机号,则只需校验登录密码。
- 单击“确定”,下载访问密钥。
说明:
为防止访问密钥泄露,建议您将其保存到安全的位置。
- 获取示例代码,解压缩。
- 通过import方式将示例工程导入到Eclipse。
图2 选择已存在的工程图3 选择解压后的示例代码图4 导入成功后工程结构示例
- 对请求进行签名。
签名方法集成在3引入的jar文件中。发送请求前,需要对请求内容进行签名,得到的签名结果将作为http头部信息一起发送。
Demo代码分成三个类进行演示:
- AccessService:抽象类,将GET/POST/PUT/DELETE归一成access方法。
- Demo:运行入口,模拟用户进行GET/POST/PUT/DELETE请求。
- AccessServiceImpl:实现access方法,具体与API网关通信的代码都在access方法中。
- 编辑“Demo.java”文件中的main方法,将以下内容替换为实际获取到的值。
如果调用其他方法,如POST,PUT,DELETE等,请参考对应注释方法。
注意替换region、serviceName、AK/SK和URL,Demo中使用了获取VPC的URL,请替换为您需要的URL:
URL中project_id获取请参见获取项目ID。
Endpoint请向企业管理员获取。
//TODO: Replace region with the name of the region in which the service to be accessed is located. private static final String region = ""; //TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb. private static final String serviceName = ""; public static void main(String[] args) throws UnsupportedEncodingException { //TODO: Replace the AK and SK with those obtained on the My Credential page. String ak = "ZIRRKMTWP******1WKNKB"; String sk = "Us0mdMNHk******YrRCnW0ecfzl"; //TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header. //TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID. //TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file. //TODO: Test the API String url = "https://{Endpoint}/v1/{project_id}/vpcs"; get(ak, sk, url); //TODO: When creating a VPC, replace {project_id} in postUrl with the actual value. //String postUrl = "https://serviceEndpoint/v1/{project_id}/cloudservers"; //String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}"; //post(ak, sk, postUrl, postbody); //TODO: When querying a VPC, replace {project_id} in url with the actual value. //String url = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //get(ak, sk, url); //TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values. //String putUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //String putbody ="{\"vpc\":{\"name\": \"vpc1\",\"cidr\": \"192.168.0.0/16\"}}"; //put(ak, sk, putUrl, putbody); //TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values. //String deleteUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; //delete(ak, sk, deleteUrl); }
- 编译与运行接口调用。
在左侧“Package Explorer”中找到“Demo.java”,右键选择“Run AS >Java Application”并单击运行。
可在控制台查看调用日志。