检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置APIG实例参数 配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。
配置是否预处理策略。当编排规则为预处理时,将该编排规则生成的参数值作为临时参数,成为下一个编排规则的待编排参数。 参数名称 当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。 填写编排后的参数名称。 参数类型 当“是否预处理策略”开关关闭或者“编
操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 请登录AP
内置参数、前端认证参数和后端认证参数等,可以通过设置系统参数来实现。API网关向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表8 系统参数配置 参数 说明 系统参数类型 选择系统参数的类型。
API的功能,不仅大幅提升了性能,还简化了架构,降低了部署和运维成本。 便捷调试工具 API网关提供页面调试工具,您可以使用该工具添加HTTP头部参数与body体参数,对API进行调试,简化API开发,降低API的开发维护成本。 版本管理 API可以发布到不同的环境,如果您需要再次发布此API到
如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用前端自定义认证参数,为特殊调用方分配专用的后端服务。本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端
调用API报“414 Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: 调用API
在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。 后端策略限制,如下所示。
更新指定VPC通道的参数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
0 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述
PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 环境的ID,可通过查询环境信息获取该ID 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 环境的名称
"remark": "开发环境" } 响应消息 表4 参数说明 参数 类型 说明 id String 环境ID name String 环境名 create_time Timestamp 创建环境的时间 remark String 描述信息 响应参数样例: { "id": "cca3616
表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
"调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称,由字母、数字、下划线、连线、点组成,以字母开头,最长32字节 header位置的参数名称不区分大小写 value 是 String 参数值,当参数来源为REQUEST时,值为请求参数名称 in 是
表2 配置策略后端 参数 配置说明 后端策略名称 填写后端策略名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 后端服务类型 此处选择“Mock”。 Mock返回结果 此处填写“策略后端”。 策略条件 条件来源:选择“系统参数-前端认证参数”。 参数名称:填写前提条件已
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的分组总数 size Integer 本次查询返回的分组个数 purchases 字典数据类型 本次查询返回的分组列表 表4 purchases参数说明 参数 类型 说明 id String
/v1/{project_id}/apigw/instances/{instance_id}/app-auths URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String VPC通道的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明