检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 否
api_name 否 String API名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer
否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的流控策略总数 size Integer
否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的流控策略总数 size Integer
否 String 授权的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer
api_name 否 String API名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer
表1 分组对象模型 参数名称 数据类型 参数说明 操作类型 是否必选 ID String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R
第一个身份来源参数位置选择“Header”,参数名填写“token”;第二个身份来源参数位置选择“Query”,参数名填写“test”。 在左侧导航栏选择“API管理 > API列表”,单击“创建API > 创建API”。 根据下表参数,配置前端信息。 表3 前端配置 参数 配置说明
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
表1 分组对象模型 参数名称 数据类型 参数说明 操作类型 是否必选 ID String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R
即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题: API认证鉴权
中获取的请求路径。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的调用信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type:
专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。“request_body_size”表示API请求中允许携带的Body大小上限,支持修改范围1~9536 M。
req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required
0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String
每页显示的条数,默认值:20,最大值500。page_size值为0时,返回所有API。 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称
每页显示的条数,默认值:20,最大值500。page_size值为0时,返回所有API。 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称
表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required
在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。 后端策略限制,如下所示。