检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
property 前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息
字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。
获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type
VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type
API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写
com:7443)。如果不写端口,则HTTPS默认端口号为443,HTTP默认端口号为80。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、下划线、中划线组成,且只能以英文开头 req_protocol String 请求协议,后端类型为GRPC时请求协议可选GRPC、GRPCS
/ %- _ . 等特殊字符,总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。 说明: 需要服从URI规范。 auth_type String API的认证方式
/ %- _ . 等特殊字符,总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。 说明: 需要服从URI规范。 auth_type String API的认证方式
自定义认证列表 表5 AuthorizerResp 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type String 自定义认证类型 FRONTEND:前端 BACKEND:后端
"{\"status\": \"allow\", \"context\": {\"user\": \"abc\"}}" } 其中,body字段的内容为字符串格式,json解码之后为: { "status": "allow/deny", "context": { "user": "abc"
是否必选 参数类型 描述 cert_content 是 String 证书内容 name 是 String 证书名称。长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、下划线组成,且只能以英文或中文开头。 private_key 是 String 私钥内容 响应参数 状态码: 201
分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 status Integer
String 请求消息体,最长2097152字节 header 否 Map<String,Array<String>> 头域参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写
"{\"status\": \"allow\", \"context\": {\"user\": \"abc\"}}" } 其中,body字段的内容为字符串格式,json解码之后为: { "status": "allow/deny", "context": { "user": "abc"
[\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"} ssl_ciphers 支持的加解密套件。ssl_ciphers数组中只允许出现默认值中的字符串,且数组不能为空。 - ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384
R 缺省值:DISABLE 表6 ReqParam 参数 参数类型 描述 name String 参数名称。 长度为1 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。 type String 参数类型 location String 参数位置
分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 name String 响应名称
接上,允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP协议在实时性和交互性方面的不足。它广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket A
分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 name String 响应名称
创建API 操作场景 API提供者把API接口配置在API网关中,开放后端能力。 创建API主要分为四个步骤:设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A