检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地址
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
ontrol,Range 正式请求允许的头域。 Access-Control-Allow-Methods GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH 正式请求允许的方法。 父主题: APIG的API设计文件扩展定义
name: test in: query required: true 父主题: APIG的API设计文件扩展定义
AppCode简易认证类型,默认为disable。 disable:不开启简易认证 header:开启简易认证且AppCode位置在HEADER。 父主题: APIG的API设计文件扩展定义
x-apigateway-any-method 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。 作用域:Path Item Object(2.0)/Path Item Object(3.0) 示例: paths: '/path': get:
mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型后端服务定义。 父主题: APIG的API设计文件扩展定义
"error_msg":"Access denied","request_id":"$context.requestId"} 父主题: APIG的API设计文件扩展定义
含义:API的网关响应名称。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: x-apigateway-response: test 父主题: APIG的API设计文件扩展定义
含义: API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json 父主题: APIG的API设计文件扩展定义
x-apigateway-match-mode 含义:API网关定义的API请求URL的匹配模式,支持NORMAL和SWA。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
表1 参数说明 参数 是否必选 类型 说明 x-apigateway-plugins 否 Array API所绑定的插件名列表。 父主题: APIG的API设计文件扩展定义
API类型,支持public和private。 public:公开类型API,可以上架。 private:私有类型API,不会被上架。 父主题: APIG的API设计文件扩展定义
name: test in: query required: true` 父主题: APIG的API设计文件扩展定义
认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
是 String 参数位置。 validation 否 String 参数校验表达式,默认为null,不做校验。 父主题: APIG的API设计文件扩展定义
name: test in: query required: true 父主题: APIG的API设计文件扩展定义
special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略。 父主题: APIG的API设计文件扩展定义
否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
参数说明 参数 是否必选 类型 说明 x-apigateway-ratelimit 否 String 流控策略。 父主题: APIG的API设计文件扩展定义