检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。API的真实后端服务目前支持四种类型:传统的HTTP/
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
String 分组的编号 domain_id 是 String 域名的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 证书名称。 长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、"_"组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。
name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String APP描述。 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 domain 否 String API的访问域名,如果使用自定义入方向端口的特性时,需要带上端口信息,用冒号分隔,例如test.com:8080。 API的访问域名未提供时根据mode的取值使用如下默认值:
该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。 URI HTT
自定义认证参数说明 参数 说明 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 版本或别名 选择函数的版本或别名,函数的版本或别名功能请参考《函数工作流 FunctionGraph用户指南》。
name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String APP描述。 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。
String 指定已有的分组,为空时创建新的分组 最小长度:0 最大长度:64 group_name 否 String API分组的名称,group_id为空时必填。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。
ject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、中划线、下划线、点组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
TmsMatchesKeyValue objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表4 TmsKeyValues 参数 是否必选 参数类型 描述
是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、中划线、下划线、点组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 port 是 Integer VPC通道中主机的端口号。 取值范围1 ~ 65535。
VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type 是 Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型
监控信息 参数 配置项 带宽IP 带宽IP为实例的入口或出口IP,可在实例信息中查看。 时间段 支持查看“近1小时”、“近3小时”、“近12小时”、“近24小时”或“近7天”的数据监控时间段,也可以单击自定义时间段。同时,监控指标视图右上角会动态显示对应时段内监控指标的最大值与最小值。
查看APIG的监控指标 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面左侧选择API。
请求参数匹配编排规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高; 如果编排规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则def
ject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 环境的名称,支持英文,数字,下划线,且只能以英文字母开头。 最小长度:3 最大长度:64 remark 否 String 描述信息 说明: 中文字符必须为UTF-8或者unicode编码。
objects 本次查询到的VPC通道列表 表5 VpcChannelInfo 参数 参数类型 描述 name String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、中划线、下划线、点组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。