检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses 否 Object 响应定义,参考表9 security
功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST /v2/{pro
API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses 否 Object 响应定义,参考表9 security
API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses 否 Object 响应定义,参考表9 security
API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses 否 Object 响应定义,参考表9 security
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题: 共享版API(仅存量用户使用)
x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型后端服务定义。 functionEndpoints 否 x-apigateway-backend.functionEndpoints FUNCTION类型后端服务定义。 mockEndpoints 否 x-apigateway-backend
专享版-分组自定义响应管理 创建分组自定义响应 查询分组自定义响应详情 修改分组自定义响应 删除分组自定义响应 查看分组下指定错误类型的自定义响应 修改分组下指定错误类型的自定义响应 删除分组指定错误类型的自定义响应配置 查询分组自定义响应列表 父主题: 专享版API(V2)
x-apigateway-any-method 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。 作用域:Path Item Object(2.0)/Path Item Object(3.0) 示例: paths: '/path': get:
对接函数的网络架构类型。 V1:非VPC网络架构 V2:VPC网络架构 缺省值:V1。 retry_attempts 否 Number 重试次数。 timeout 否 Number 超时时间。 ttl 否 Number 缓存时间。 type 是 String 自定义认证类型。 FRONTEND:前端
API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json 父主题: APIG的API设计文件扩展定义
参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义
x-apigateway-plugins: ['Plugin_mock'] 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-plugins 否 Array API所绑定的插件名列表。 父主题: APIG的API设计文件扩展定义
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
x-apigateway-match-mode 含义:API网关定义的API请求URL的匹配模式,支持NORMAL和SWA。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
x-apigateway-auth-type: IAM 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-auth-type 是 String API网关认证方式,支持AppSigv1、IAM。 type 是 String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。
据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证依赖于函数工作流服务,创建自定义认证前,需要先创建函数。 操作流程 创建函数 创建自定义的前端函数,使用函数服务开发自定义认证。 创建自定义认证 创建自定义认证,类型选择“前端”,函数地址选择上一步创建的函数。
是否必选 类型 说明 x-apigateway-is-send-fg-body-base64 否 boolean 是否对与FunctionGraph交互场景的请求体进行Base64编码。 true:编码。 false:不编码。 父主题: APIG的API设计文件扩展定义
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选 id
是否必选 类型 说明 customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义