检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
说明 - 字典数据类型 API与签名密钥的绑定关系列表 表4 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String API名称 api_remark String API描述 group_name
instance_type String 对象类型APP/USER CR 是 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 CRU 是 apply_time Timestamp 设置的时间 R - 父主题: 设置特殊流控(待下线)
API的后端服务报“Backend domain name resolution failed” APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。 可能原因 APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/envs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型
查询实例指定的自定义入方向端口绑定的域名信息 查询实例的自定义入方向端口列表 新增实例的自定义入方向端口 删除实例指定的自定义入方向端口 父主题: 专享版API(V2)
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通
方案概述 应用场景 API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)
义认证章节创建。 配置API前端 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。
删除流控策略 功能介绍 删除指定的流控策略,以及该流控策略与API的所有绑定关系。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}
APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 app_type String APP类型,默认为apig bind_num Integer 绑定的API数量 响应消息样例: { "total": 2, "size": 2, "apps": [{ "id":
签名密钥创建后,需要绑定到API才能生效。 将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 签名密钥的ID。
查看编排规则列表 功能介绍 查看编排规则列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/orchestrations 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询实例的自定义入方向端口列表 功能介绍 查询实例的自定义入方向端口列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports 表1 路径参数 参数
API发布到不同环境后,会调用不同的后端服务吗? 使用环境变量,或者在后端服务定义不同的参数,可以实现API发布到不同环境时,调用不同的后端服务。 有关环境变量的详细指导,请参考创建环境变量。 父主题: 发布API
"error_code" : "APIG.3325", "error_msg" : "The API quota name already exists" } 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg"
使用API网关实例的时间长度,支持使用1~9个月,或者1~3年。 购买个数(个) 使用API网关实例的个数。 公网带宽 API请求出公网带宽 按需计费。 表2 按需模式计费项信息 计费项目 计费项说明 适用的计费模式 计费公式 版本 API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根