检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
String 域名的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 证书名称。 长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、"_"组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content
Array of strings 白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。 其中,授权账号ID是长度为32的字符串,只包含英文字母(a-f)或数字;也可为*,表示允许全部用户连接。 数组长度:1 - 50 响应参数 状态码: 200 表4 响应Header参数
Array of strings 白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。 其中,授权账号ID是长度为32的字符串,只包含英文字母(a-f)或数字;也可为*,表示允许全部用户连接。 数组长度:1 - 50 响应参数 状态码: 200 表4 响应Header参数
0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND:前端 BACKEND:后端
如果您想要使用自己的认证系统对API的访问进行认证鉴权,您可以在API管理中创建一个前端自定义认证来实现此功能。在使用前端自定义认证对前端请求进行认证鉴权前,您需要先在FunctionGraph创建一个函数,通过函数定义您所需的认证信息。函数创建完后,作为自定义认证的后端函数,对API网关中的API进行认证鉴权。
获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String API分组的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否
0/apigw/api-groups 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String API分组的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否
)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND:前端 BACKEND:后端
自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
property 前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息
API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写
API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写
/ %- _ .等特殊字符,总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。 说明: 需要服从URI规范。 auth_type String API的认证方式。
0/apigw/vpc-channels 请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type
获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type
VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type
添加策略后端前,必须定义一个默认后端,不满足任何一个策略后端的API请求,都将转发到默认的API后端。 “系统参数-前端认证参数”策略条件的“条件值”只支持字符串、整数、布尔值三种类型的值。 一个API最多定义5个策略后端。 父主题: 通过匹配系统参数-前端认证参数调用API的策略后端