检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
更新专享版实例 功能介绍 更新专享版实例 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
创建专享版实例(按需) 功能介绍 创建按需专享版实例 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
实施步骤 创建策略。 登录API网关控制台,创建流量控制2.0策略。具体操作步骤请参考《API网关用户指南》中的流量控制2.0策略。 在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息
创建并使用签名密钥 操作场景 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名
实施步骤 登录函数工作流控制台,在“总览”页面,单击“创建函数”。详情请参考使用FunctionGraph服务实现APIG的自定义认证。 根据下表,填写函数信息后,单击“创建函数”。 表1 函数信息配置 参数 配置说明 函数类型 默认“事件函数”。 区域 与API网关相同区域。 项目
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
创建专享版实例(包周期) 功能介绍 创建包周期专享版实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/prepay-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。
配置API的后端服务签名校验 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书(可选) 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。
修改流控策略 功能介绍 修改指定流控策略的详细信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} 表1 路径参数 参数 是否必选 参数类型
续费概述 包年/包月实例到期后会影响实例正常运行。如果您想继续使用,需要在指定的时间内为实例续费,否则实例资源会自动释放,数据丢失且不可恢复。 续费操作仅适用于包年/包月实例,按需计费实例不需要续费,只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功,所有资源得以保留,
修改流控策略 功能介绍 修改指定流控策略的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调用方法 请参见如何调用API。 URI POST /v2/{
修改流控策略 功能介绍 修改指定流控策略的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/throttles/{id}
实施步骤 准备CCE工作负载信息 创建集群。 登录云容器引擎控制台,在“集群管理”页面购买CCE Standard集群或CCE Turbo集群。此处选择CCE Standard集群,容器网络模型为“VPC网络”,具体操作步骤请参见购买CCE集群。 集群创建完成后,记录容器网段。