检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关服务的只读访问权限。拥有该权限的用户只能查看API网关服务的各类信息。 系统策略 无。 示例流程 图1 给用户授权API网关服务权限流程 创建用户组并授权 在IAM控制台创建用户组,并授予API网关服务的权限“APIG Administrator”或“APIG FullAccess”。 创建用户并加入用户组
怎样给指定的用户开放API? 可以采用以下两种方式: 创建API时可选取APP认证方式,AppKey和AppSecret分享给指定的用户。 使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 父主题: API策略
custom_data_log1 用户自定义日志字段值1。 40 custom_data_log2 用户自定义日志字段值2。 41 custom_data_log3 用户自定义日志字段值3。 42 custom_data_log4 用户自定义日志字段值4。 43 custom_data_log5 用户自定义日志字段值5。
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
1,那么采样的线上请求流量为100。 超时时间(ms) 镜像请求的超时时间,单位ms。默认超时时间为5000ms。 客户端请求体 镜像客户端的请求体,默认开启镜像客户端请求体。 单击“确定”。 如果您需要复制已创建的策略,请在已创建策略的“操作”列中单击“克隆”配置参数即可。克隆策略的名称不能与已创建的策略名称重复。
CTS的详细介绍和开通配置方法,请参见CTS快速入门。 APIG用户查看云审计日志方法,请参见云审计日志。 日志 APIG支持日志自定义分析模板,便于日志的统一收集和管理,也可通过API异常调用分析进行追查和溯源。 关于APIG日志记录的详细介绍和配置方法,请参见日志分析。 父主题: 安全
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
单击“SDK使用指引”页签。 在待下载的语言中,单击“下载SDK”,下载SDK包。 如需查看文档,请单击“SDK文档”。 父主题: 共享版操作指导(仅存量用户使用)
创建API分组 操作场景 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
在“AppCodes”页签中获取AppCode。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 构造API请求,示例如下: POST http
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 配置实例标签 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 共享版操作指导(仅存量用户使用)
deleteApp 更新应用 App updateApp 重置签名密钥 App resetAppSecret 客户端绑定API AppAuth grantAuth 客户端解绑API AppAuth relieveAuth 创建签名密钥 Signature createSignature
向API提供者获取请求参数中要携带的第三方认证信息。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 API调用支持长连接。但是需要适当使用长连接,避免占用太多资源。
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
环境管理 创建环境和环境变量 删除环境 父主题: 共享版操作指导(仅存量用户使用)