检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英
0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API,或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下: syntax = "proto3";
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size
success Array 发布或下线成功的信息 failure Array 发布或下线失败的API及错误信息 表5 success参数说明(批量发布) 名称 类型 说明 publish_id String 发布记录的ID api_id String 发布成功的API ID api_name
描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
单击“下一步”,进入API的后端设置页面,修改已添加策略后端的策略条件值为“True”。 单击“完成”,完成API的编辑。 再次调试API。 由于此时设置的策略后端的参数和条件值没有匹配到前端自定义认证函数返回体中context字段下的任意键值对,因此,无法通过前端自定义认证参数匹配到API的策略后端,此时API的响应结果显示“200
源IP流量限制是指一个API在时长之内被每个IP访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
如需导出日志,具体步骤请参见日志转储。 访问日志的字段采用空格作为分隔符,按照顺序,每个字段的含义如下: 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时,请求方提供的项目ID 5
String VPC通道的编号。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type
源IP流量限制是指一个API在时长之内被每个IP访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance
类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
String API版本的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选