检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 task_id
/v2/{project_id}/apigw/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
缓存时间 user_data 否 String 用户数据 表3 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String 参数位置: HEADER:头 QUERY:query 请求消息样例: { "n
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
描述 X-Request-Id 请求ID。所有合法请求,都会返回此参数。 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时。仅在请求消息头包含X-Apig-Mode: debug时,返回此参数。 X-Apig-Upstream-Latency 从API网关请
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
FRONTEND:前端 BACKEND:后端 表2 Identity 参数 是否必选 类型 说明 name 是 String 参数名称。 location 是 String 参数位置。 validation 否 String 参数校验表达式,默认为null,不做校验。 父主题: APIG的API设计文件扩展定义
"remark": "开发环境" } 响应消息 表4 参数说明 参数 类型 说明 id String 环境ID name String 环境名称 create_time Timestamp 创建时间 remark String 描述信息 响应参数样例: { "id": "cca3616a
String 创建时间 状态码: 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
仅在“条件来源”为“请求入参”、“系统参数”、“COOKIE”时需要配置。 相等:请求参数值必须为输入值时,条件成立。 枚举:请求参数值只需要和枚举值中任何一个值相同,条件成立。 匹配:请求参数值只需要和正则表达式中任何一个值相同,条件成立。 说明: 当“条件来源”为“系统参数”并且“参数名称”为“re
则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。
ON对象或数组。 context中的数据为您自定义的字段,认证通过后作为认证参数映射到API网关后端参数中,其中context中的参数名称与系统参数名称必须完全一致,且区分大小写。context中的参数名称必须以英文字母开头,支持英文大小写字母、数字、下划线和中划线,且长度为1 ~
您可以根据以下操作流程为API创建并绑定流量控制2.0策略。 创建策略 填写流量控制2.0策略基本信息。 配置基础流控 配置基础流量控制。 配置参数流控 开启参数流控配置开关,定义参数和规则配置参数流量控制。 配置特殊流控 开启特殊流控配置开关,特殊凭据与特殊租户流量控制的使用场景。 绑定API 流量控制2.0策略绑定到API。
策略的配置内容,支持表单配置和脚本配置两种方式。 响应缓存键 配置参数作为响应缓存键,用于区分不同的缓存。 system_params类型:配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型:配置不同的请求query参数作为响应缓存键来区分缓存。 head
指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明 参数 类型 说明 id
0策略可以限制单位时间内API的被调用次数,支持基础流控、参数流控和基于基础流控的特殊流控。 基础流控:可以对API、用户、凭据、源IP进行多维度流控,与已有的流量控制策略说明功能一致,但配置方式不兼容。 参数流控:支持根据Header、Path、Method、Query以及系统变量中的参数值进行自定义流控。 基于
API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面,单击“更多 > 克隆”。 根据下表参数说明,自定义API名称和API前端路径,单击“确定”。 表1 克隆API配置 参数 说明 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。
range. 参数值不在可选范围内 修改请求参数 400 APIG.2005 The parameter is too short. 参数长度太短 修改请求参数 400 APIG.2006 The parameter is too long. 参数长度太长 修改请求参数 400 APIG
请求消息 表2 参数说明 名称 是否必选 类型 说明 id 否 String 签名密钥编号 name 否 String 签名密钥名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明
E环境的API。如果要访问其他环境上的API,需要在API请求中添加Header参数“X-Stage”,参数值为环境名。例如要访问环境名为“Develop”上的API,则在API请求的Header参数中添加“X-Stage: Develop”。 创建环境变量 进入API网关控制台页面。