检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品咨询 如何将API服务上架到华为云商店上售卖? API分组为什么无法上架到云商店? API、环境、凭据之间的关系? API网关共享版是否可以升级到专享版? APIG控制台所有按钮均无法单击如何处理? 怎样保护API的调用安全? 怎样保证API网关调用后端服务器的安全?
API受API超时时间的限制,如果当前WebSocket连接空闲时间超过了配置的超时时间,并且没有ping/pong保活,则连接会被自动断开。 前提条件 准备一个已做ping/pong保活的WebSocket服务后端。 操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
使用JavaScript SDK生成curl命令。 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。 或直接下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo.html,页面如下图所示。 填入Key、Secret、方法名、请求协议、域名和url。
操作步骤 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 通过以下任意一种方式,进入对话框。 在待删除的应用所在行,单击“删除”。 单击“应用名称”,进入应用详情页面,在右上角单击“删除”。 仅在应用未绑定任何API时,支持删除,否则请先解绑API。
它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建GRPC API”。更多详细指导,请参见创建GRPC
14或以上版本,如果未安装,请至Go官方下载页面下载。 已安装IntelliJ IDEA 2022.2.1或以上版本,如果未安装,请至IntelliJ IDEA官方网站下载。 已在IntelliJ IDEA中安装Go插件,如果未安装,请按照图1所示安装。 图1 安装Go插件 获取SDK 请登录API网关控制台
Engine,简称CCE)工作负载,提供API注册开放CCE服务能力。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。 您需要确保当前实例与CCE集群所属同一个VPC中,或通过其他方式保证两者网络可达,否则导入后调用API会出现失败场景。
API的响应码如何定义? API响应码分两种。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
使用APIG专享版实现http到https自动重定向 当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。 使用APIG专享版实现gRPC服务的路由转发 当用户使用gRPC服务时,可以通
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
图1 自定义认证函数 已创建前端自定义认证。如果未创建,请参考自定义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置
API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入“授权应用”页面。 在待授权的API所在行,单击“更多 > 授权”,进入“授权API”页面。单击“添加应用”,弹出“授权应用”对话框。 勾选待授权的API,单击“授权”,进入“授权API”页面。单击“添加应用”,弹出“授权应用”对话框。
API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
导出JSON、YAML或YML格式的API。API网关支持单个API导出和批量API导出。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理 >
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
调试,每天最多可以访问默认子域名1000次。 创建API 把已有后端服务封装为标准RESTFul API,并对外开放。 API创建成功后,您可根据业务需求对API设置访问策略: 流控控制 流量控制可限制单位时间内API的被调用次数,保护后端服务。 访问控制 访问API的IP地址和
更新后端实例 功能介绍 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组,则进行全量覆盖。 引用负载通道类型的负载通道不支持更新后端实例。 调用方法 请参见如何调用API。 URI PUT /v2/{p
API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
与“时长”配合使用,表示单位时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅适用于API的安全认证方式为APP认证或IAM认证。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。