检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求这个
创建并使用签名密钥 操作场景 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
修改分组自定义响应 功能介绍 修改分组自定义响应 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id
实施步骤 单向认证 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 创建SSL证书。 在左侧导航栏选择“API管理 > API策略”。 在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称,建议您按照一定的命名规则填写
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。
查询分组自定义响应详情 功能介绍 查询分组自定义响应详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/
获取异步任务结果 功能介绍 获取异步任务结果。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述
创建API的负载通道(可选) 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能(服务器通道类型),以及自动同步服务节点变更的能力(微服务通道类型)和使用已有的负载通道能力(引用负载通道类型),
查看APIG的带宽监控 API网关支持查看出入口带宽各项指标的监控数据。 前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表
专享版-环境管理 创建环境 修改环境 删除环境 查询环境列表 父主题: 专享版API(V2)
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为
查看VPC通道详情 功能介绍 查看指定的VPC通道详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} 表1 路径参数 参数
专享版-设置特殊流控 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 专享版API(V2)
修订记录 表1 文档修订记录 发布日期 修订记录 2024-06-26 新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口
环境管理(待下线) 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 专享版API(V1)(待下线)
创建自定义认证 操作场景 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时
APP管理(待下线) 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 父主题: 专享版API(V1)(待下线)