检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面的“监控视图”区域,单击“
无需创建凭据。 约束与限制 每个实例最多创建50个凭据,每个凭据最多绑定1000个API。 一个凭据可以绑定多个APP认证的API,一个APP认证的API可以绑定多个凭据。 创建凭据 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
配模式为“绝对匹配”。 发布API相关的FAQ 对API的修改是否需要重新发布? API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到不同环境后,会调用不同的后端服务吗? 后续操作 API发布完成后,您或API调用者就可以调用API了。如
String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval
作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time Timestamp 设置时间 app_id String 作用的APP编号 app_name String
VPC通道管理(待下线) 对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 专享版API(V1)(待下线)
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 oas_version 否 String OpenAPI版本
包年/包月实例到期后会影响实例正常运行。如果您想继续使用,需要在指定的时间内为实例续费,否则实例资源会自动释放,数据丢失且不可恢复。 续费操作仅适用于包年/包月实例,按需计费实例不需要续费,只需要保证账户余额充足即可。 包年/包月实例在到期前续费成功,所有资源得以保留,且实例的运行不
响应Body参数 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 name String 流控策略名称。支持汉字,英文
求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。 单击“创建编排规则”,根据下表参数说明,配置编排规则。 表1
位时间,以此类推。 时长 填写配额限制的时长,单位可选择“秒”、“分”、“时”和“天”。需与“API访问限制”配合使用,表示单位时间内客户端可调用API的总次数上限。 API访问限制 填写客户端可调用API的次数上限,与“时长”配合使用。 描述 填写客户端配额策略的描述信息。长度为1~255个字符。
X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 call_limits 是 Long 流控时间内特殊对象能够访问API的最大次数限制 响应参数
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE:
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String API的编号 name 否 String API的名称 group_id 否 String
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供
API网关 APIG 介绍如何调用API(简易认证) 02:01 调用API(简易认证) API网关 APIG 介绍如何创建访问控制策略 01:52 创建访问控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) 最佳实践 API网关 APIG
String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Toke
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。