检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup
incident:表示比操作失败更严重的情况,例如引起其他故障等。 企业项目ID:输入企业项目ID。 访问密钥ID:输入访问密钥ID(包含临时访问凭证和永久访问密钥)。 时间范围:可选择查询最近1小时、最近1天、最近1周的操作事件,也可以自定义最近7天内任意时间段的操作事件。 您可以参考云审
incident:表示比操作失败更严重的情况,例如引起其他故障等。 企业项目ID:输入企业项目ID。 访问密钥ID:输入访问密钥ID(包含临时访问凭证和永久访问密钥)。 时间范围:可选择查询最近1小时、最近1天、最近1周的操作事件,也可以自定义最近7天内任意时间段的操作事件。 您可以参考云审
HTTPS BOTH:同时支持HTTP和HTTPS GRPCS 缺省值:HTTPS req_method String API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 req_uri String 请求地址。可以包含请求参数,用{}标识,比如/g
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project
String API的请求协议 HTTP HTTPS BOTH:同时支持HTTP和HTTPS 缺省值:HTTPS req_method String API的请求方式 req_uri String 请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持
String API的请求协议 HTTP HTTPS BOTH:同时支持HTTP和HTTPS 缺省值:HTTPS req_method String API的请求方式 req_uri String 请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持
添加用户网站的防护域名和域名绑定的证书。如果没有域名,请参考域名注册服务注册域名;证书可通过云证书管理服务申请。 填写的域名须备案,如果没有备案,请参考域名备案。 选择实例与线路。 选择已购买的实例,单击“提交并继续”。 单击“下一步”。 单击“完成”。 确认已开启CNAME自动调度和安全防护。
接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。 已搭建完成后端服务。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入API调试页面。
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。适用于生成Swagger或OpenAPI格式的API文档定义。 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将
删除插件 功能介绍 删除插件。 必须先解除API和插件的绑定关系,否则删除报错 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
获取签名密钥信息: 在APIG实例控制台选择“API管理 > API策略 > 策略管理”,单击签名密钥名称进入详情页面,在“策略内容”区域查看Key和Secret。 父主题: 对后端服务进行签名
前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题:
APIG专享版支持单向认证和双向认证两种认证方式,两种认证方式开启认证的流程相同,下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。
通过API设计文件导入API 将Swagger或OpenAPI定义的API导入到API网关,支持导入到新分组和导入到已有分组两种方式。导入前您需要在API定义中补全API网关的扩展定义。 注意事项 API网关中API分组和API的配额满足需求。 如果使用Swagger info或OpenAPI info的
布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。 已创建环境。 发布API
暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,下线API。
暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
控您可以全面了解云上的资源使用情况、业务的运行状况,并及时收到异常告警做出反应,保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。 关于APIG支持的监控指标,以及如何创