检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
否 String API标签,该参数可指定多个,多个不同的参数值为或关系;不指定或为空时,表示不筛选标签;指定为#no_tags#时,表示筛选无标签API。 最小长度:0 最大长度:128 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数 仅在“Path”中存在“{}”时,支持修改。 请求头 HTTP Headers的参数与参数值。 查询参数 Query的参数与参数值。 Body 仅在“Method”为“PATCH”/“POST”/“PUT”时,支持修改。 添加请求参数后,单击“发送请求”。
D。 “系统参数类型”为“前端认证参数”/“后端认证参数”时,此参数名称必须和自定义认证函数返回结果中的参数名称一致。 后端参数名称 将系统参数映射到后端参数中。设置需要映射的后端参数名称。 说明: 参数名不能为x-apig- 、x-sdk-开头,不区分大小写。 参数名不能是x-stage,不区分大小写。
req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required
指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用前端自定义认证参数,为特殊调用方分配专用的后端服务。本方案以“系统参数-前端认证参数”为例,讲述用户如何通过设置“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次查询返回的列表长度 app_codes
req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required
仅在API请求的“匹配模式”为“前缀模式”时,支持自定义路径。 路径 API的请求path。 路径参数 仅在API请求的“请求Path”中存在“{}”时,支持修改。 查询参数 Query的参数与参数值。 请求头 HTTP Headers的参数与参数值。 请求体 仅在API请求的“Method”定义为“PATCH”
/v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String VPC通道的编号。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String VPC通道的编号。 name
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
"调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称,长度不能超过32个字节,由字母、数字、下划线、连线或点组成,且必须以字母开头。 header位置的参数名称不区分大小写。 value 是 String 参数值,当参数来源为REQUEST时,值为请求参数名称。
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id
String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的分组总数 size Integer 本次返回的列表长度 groups 字典数据类型 分组列表 表4 字典数据类型:分组字段说明
String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的分组总数 size Integer 本次返回的列表长度 groups 字典数据类型 分组列表 表4 字典数据类型:分组字段说明
/v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
调用API报“414 Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: 调用API
请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id