检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
tances/{instance_id}/api-groups”,project_id为项目ID,instance_id为实例ID(在APIG控制台的“实例信息”中查看)。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”
String API的类型 表8 前端parameters参数说明 名称 是否必选 参数类型 说明 maximum 否 Float 参数为数值类型时,最大参数值 minimum 否 Float 参数为数值类型时,最小参数值 maxLength 否 Integer 参数为字符串类型时,参数的最大长度
“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选 id String 特殊配置的编号 R - strategy_id String 流控策略编号 CR 是 instance_id String 生效的特殊对象的编号 CR
“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选 id String 特殊配置的编号 R - strategy_id String 流控策略编号 CR 是 instance_id String 生效的特殊对象的编号 CR
API提供的默认网关响应“default”也可以编辑修改。 您可以新增多个网关响应,支持同一分组下不同API配置不同的网关响应内容。 网关响应所定义的错误类型固定且不可修改,具体见网关错误响应类型说明。 响应内容支持调用API网关运行时变量($context变量),具体见API网关运行时可获取变量。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 plugin_id 是 String 插件编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型
API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) 最佳实践 API网关 APIG 在API网关上开放内网ELB中的服务 08:36 API网关跨VPC开放后端服务 API网关 APIG 介绍SDK的获取和使用 02:22 如何获取和使用SDK API网关
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
创建分组自定义响应 查询分组自定义响应详情 修改分组自定义响应 删除分组自定义响应 查看分组下指定错误类型的自定义响应 修改分组下指定错误类型的自定义响应 删除分组指定错误类型的自定义响应配置 查询分组自定义响应列表 父主题: 专享版API(V2)
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id path 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 extend_mode query 否 String 扩展信息导入模式,取值可选merge和override。
0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String API分组的编号 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 名称。 长度为3 ~ 64位的字符串,字符串由中文、英
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。
参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 流控时间内特殊对象能够访问API的最大次数限制 instance_id 是 String 特殊APP的编号或特殊租户的账号ID instance_type 是 String 对象类型:APP/USER strategy_id
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String API的编号,可通过查询API信息获取该编号。 请求消息 表3 参数说明 参数 是否必选
如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访问密钥保护状态。如需配置权限请参见:给IAM用户授权,如需修改访问密钥状态请参见:访问密钥保护。 管理员可以在“用户详情”页面查看IAM用户的访
响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size Integer 本次返回的列表长度 throttles 字典数据类型 本次查询到的流控策略列表 表4 throttles参数说明 参数 类型 说明 id String 流控策略的ID
0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制
参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略值 entity_type String 对象类型: IP DOMAIN
eny”表示认证失败。 “context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型和boolean类型,键值不支持JSON对象或数组。 context中的数据为您自定义
您可以根据以下操作流程为API创建并绑定流量控制2.0策略。 创建策略 填写流量控制2.0策略基本信息。 配置基础流控 配置基础流量控制。 配置参数流控 开启参数流控配置开关,定义参数和规则配置参数流量控制。 配置特殊流控 开启特殊流控配置开关,特殊凭据与特殊租户流量控制的使用场景。 绑定API 流量控制2.0策略绑定到API。