检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用对象 小型用户。 物理隔离要求较低,能够开箱即用,快速实现API能力开放。 中大型用户。 专享版API网关拥有物理隔离的独立集群, 更丰富的特性。 满足内部API调用跟API开放,专享独立的公网带宽。 API网关的共享版与专享版在功能上的异同点如下表所示。
req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例
String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的
acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数
扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。
“context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型和boolean类型,键值不支持JSON对象或数组。
authorizer_id String 前端自定义认证对象的ID tags Array of strings 标签。 支持英文,数字,中文,特殊符号(-*#%.:_),且只能以中文或英文开头。
“context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型和boolean类型,键值不支持JSON对象或数组。
状态码: 200 表3 响应Body参数 参数 参数类型 描述 acl_name String 名称 acl_type String 类型: PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略值 entity_type String 对象类型
String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的
查看APIG的带宽监控 API网关支持查看出入口带宽各项指标的监控数据。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表
429 API调用次数超出所配置的流量策略阈值 应用未授权 401 使用的应用未被授权访问该API API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.appId API调用者的APP对象
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同
lock_scene String 限制操作场景: TO_PERIOD_LOCK:按需转包周期场景锁,不允许进行删除、规格变更、按需转包周期等 SPEC_CHG_LOCK:包周期规格变更场景锁,不允许进行删除、规格变更等 lock_source_id String 发起限制操作对象的标志
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API
操作流程 APIG专享版支持单向认证和双向认证两种认证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书
后端服务地址支持填写私有地址(子网IP)吗? 专享版:支持。实例所在同一个vpc子网内IP,或者通过专线打通的本地数据中心私有地址。 不支持专享版的网段: 0.0.0.0/8 10.0.0.0/8 100.125.0.0/16 127.0.0.0/8 169.254.0.0/16
分页显示查询结果 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?page_size
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后,系统开始记录云服务资源的操作。在创建数据类追踪器后,系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。 云审计控制台对用户的操作事件日志保留7天,过期自动删除,不支持人工删除
说明: 创建跨域资源共享策略时,默认不配置Exposed Headers,不允许浏览器的JavaScript代码解析跨域访问获得的响应头内容(除XMLHttpRequest对象的getResponseHeader()方法获得的基本响应头,Cache-Control、Content-Language