检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 注意事项 API网关中API分组和API的配额满足需求。 如果使用Swagger info或OpenAPI
0/def (可选)设置常量参数。 如果后端服务需要接收API调用者不可见的常量,可以通过设置常量参数来实现。API网关在请求后端服务时,将常量参数增加到指定请求位置,并将请求发送给后端服务。 常量参数会明文展示,为防止信息泄露,请谨慎配置。 在“常量参数”右边单击,显示常量参数列表。 单
图2 发布历史 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过配置流控策略,针对部分API进行流量控制。 约束与限制 API配置流控策略相当于流控策略同步绑定了API。同一
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息和API请求参数信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis 表1 路径参数
(可选)配置默认后端的常量参数。如果后端服务需要接收固定的常量信息,可以通过设置常量参数来实现。API网关向后端服务发送请求时,将常量参数添加到请求的指定位置,然后将请求发送给后端服务。 在“常量参数”下,单击“添加常量参数”,添加后端服务请求的常量参数。 常量参数会明文展示,为防止信息泄露,请谨慎配置。
> 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版
BackendParamBase 参数 是否必选 参数类型 描述 origin 是 String 参数类别: 后端服务参数:REQUEST 常量参数:CONSTANT 系统参数:SYSTEM name 是 String 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/
启用后,需单击“编辑”,添加需在调用日志中打印的参数。 须知: 自定义日志只支持打印由客户端发起的请求信息,不支持打印在APIG中定义的常量参数和系统参数。 自定义日志最多可配置10个字段,且字段大小总和不得超过2KB。 参数值中的部分特殊字符会进行编码,例如:加号(+)会被编码为空格“
BackendParamBase 参数 是否必选 参数类型 描述 origin 是 String 参数类别: 后端服务参数:REQUEST 常量参数:CONSTANT 系统参数:SYSTEM name 是 String 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
2:不使用VPC通道 表15 BackendParam 参数 参数类型 描述 origin String 参数类别: 后端服务参数:REQUEST 常量参数:CONSTANT 系统参数:SYSTEM name String 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。
2:不使用VPC通道 表15 BackendParam 参数 参数类型 描述 origin String 参数类别: 后端服务参数:REQUEST 常量参数:CONSTANT 系统参数:SYSTEM name String 参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。
查看API绑定的流控策略列表 功能介绍 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bin
审计与日志 审计 云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务后,系统将开始记录APIG
java中对应位置。 HttpClientDemo中引用以下类,可在“获取SDK”包中的“src”文件下查看: Constant:demo中用到的常量。 SSLCipherSuiteUtil:tls认证配置参数的工具类,比如配置客户端不校验证书。 UnsupportProtocolException:异常处理类。
PI网关提示后端服务调用失败。 在编辑API中增加后端超时时间,或缩小后端的处理时间。 如果“后端服务地址”在ECS(Elastic Cloud Server),ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。
方法一:在创建API时,使用公网域名配置“后端服务地址”。 方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。 方法三:在创建API时,使用VPC通道(负载通道)。 创建VPC通道(负载通道)。 添加用户后端服务地址。