检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
前提条件 已创建API或新创建API,API前端配置的请求协议必须选择“HTTPS”或“HTTP&HTTPS”。 API已发布。 API所属API分组已绑定独立域名和SSL证书。 API的相关操作及绑定域名和SSL证书,请参见《API网关用户指南》。 开启重定向 登录API网关控制台,在左侧导航栏选择“API管理
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。
后端服务地址可以配置为ECS的弹性公网IP,也可以配置为您自己服务器的公网IP地址,还可以配置为域名。 有关API后端配置的详细指导,请参考创建API。 父主题: API创建
batchDeleteApi 更新API Api updateApi 发布API Api publishApi 下线API Api offlineApi 批量发布/下线API Api batchPublishOrOfflineApi 切换API版本 Api switchApiVersion 根据版本号下线API
查询分组自定义响应列表 功能介绍 查询分组自定义响应列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses 表1
义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。
方案概述 应用场景 API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)
也是使用protobuf。 当用户使用gRPC服务时,可以通过API网关创建API,实现gRPC服务的路由转发。 约束与限制 由于GRPCS协议的约束,gRPC类型的API不支持导入、导出、调试。 父主题: 基于API网关专享版实现gRPC服务的路由转发
接受或拒绝终端节点连接 功能介绍 接受或拒绝实例节点连接。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections/action 表1 路径参数
上行吞吐量(byte) current_minute Long API访问的UTC时间戳 group_id String API分组编号 provider String API拥有者 req_time String API请求时间 register_time String 记录时间 状态码:
绑定访问控制策略可控制访问API的客户端(API调用者)IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{r
API网关共享版是否可以升级到专享版? 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案: 新购买专享版实例。 导出共享版中的API。 将API导入到专享版。 重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 父主题: 其他
删除分组指定错误类型的自定义响应配置,还原为使用默认值的配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/
绑定证书 将独立域名与已创建的SSL证书绑定。 调用API 验证API是否调用成功。 父主题: 使用API网关专享版与客户端进行认证
批量删除实例终端节点连接白名单 功能介绍 批量删除实例终端节点连接白名单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions/batch-delete
批量添加实例终端节点连接白名单 功能介绍 批量添加实例终端节点连接白名单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions/batch-add
共享版:不支持。后端服务如为相同Region下的弹性云服务器,且弹性云服务器未绑定弹性IP地址,请使用VPC通道,不能直接填写弹性云服务器的私有地址。 父主题: API创建
绑定凭据配额策略 凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 在“凭据配额策略”区域,单击“绑定”。
规格变更时,出私网IP会发生变化,如有相关防火墙配置或者白名单配置需要提前放通,防止网络问题导致业务受损!期间请勿对实例进行任何操作! 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 单击待变更实例右侧的“更多 > 规格变更”。 实例参数信息请参考表1,选择升级规格,单击“下一步”。