检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
前端parameters参数说明 名称 是否必选 参数类型 说明 maximum 否 Float 参数为数值类型时,最大参数值 minimum 否 Float 参数为数值类型时,最小参数值 maxLength 否 Integer 参数为字符串类型时,参数的最大长度 minLength
API调用报错“414 Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: API调用
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
专享版实例支持的APIG特性。 若当前实例中无相关特性,可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"name":"lts","enable":true,"config":
origin类别为SYSTEM时,此字段值为系统参数名称,系统参数分为网关内置参数、前端认证参数和后端认证参数,当api前端安全认证方式为自定义认证时,可以填写前端认证参数,当api开启后端认证时,可以填写后端认证参数。 网关内置参数取值及对应含义: $context.sourceIp:API调用者的源地址
"调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称,由字母、数字、下划线、连线、点组成,以字母开头,最长32字节 header位置的参数名称不区分大小写 value 是 String 参数值,当参数来源为REQUEST时,值为请求参数名称 in 是
ame。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 api_id 是 String API的编号 env_id 否 String 环境的编号 env_name 否 String 环境的名称 请求消息 无 响应消息 表3 参数说明 名称 类型 说明
location String 参数位置: PATH QUERY HEADER FORMDATA CRU 是 default_value String 参数默认值 CRU 否 sample_value String 参数示例值 CRU 否 required Integer 参数是否必须: 1:是
range_start不大于range_end。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
POST /v1/{project_id}/apigw/instances/{instance_id}/acls URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
PUT /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 流控策略编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 流控策略名称。 支持汉
location String 参数位置: PATH QUERY HEADER FORMDATA CRU 是 default_value String 参数默认值 CRU 否 sample_value String 参数示例值 CRU 否 required Integer 参数是否必须: 1:是
origin类别为SYSTEM时,此字段值为系统参数名称,系统参数分为网关内置参数、前端认证参数和后端认证参数,当api前端安全认证方式为自定义认证时,可以填写前端认证参数,当api开启后端认证时,可以填写后端认证参数。 网关内置参数取值及对应含义: $context.sourceIp:API调用者的源地址
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
/v1/{project_id}/apigw/instances/{instance_id}/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的API历史版本总数 size Integer 本次查询返回的列表长度 api_versions 字典数据类型 本次查询返回的API历史版本列表 表4 api_versions参数说明 参数 类型 说明 version_id
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的API总数 size Integer 本次查询返回的API列表长度 bindings 字典数据类型 本次查询返回的API列表 表4 bindings参数说明 参数 类型 说明 id String
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的API总数 size Integer 本次查询返回的API列表长度 bindings 字典数据类型 本次查询返回的API列表 表4 bindings参数说明 参数 类型 说明 id String
ff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 参数流控配置 参数流控配置开关。开启后,以参数维度进行流控限制。 定义参数 定义用于规则匹配的参数。 参数位置:用于规则匹配的参数位置。
origin类别为SYSTEM时,此字段值为系统参数名称,系统参数分为网关内置参数、前端认证参数和后端认证参数,当api前端安全认证方式为自定义认证时,可以填写前端认证参数,当api开启后端认证时,可以填写后端认证参数。 网关内置参数取值及对应含义: $context.sourceIp:API调用者的源地址