检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-ratelimit 含义:引用流控策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-ratelimit:
配置API的HTTP响应头 配置API的Kafka日志推送 配置API的断路器 其他常用操作 配置API的发布环境和环境变量 配置API的访问控制 配置API的后端服务签名校验 配置API的自定义认证 调用API 调用APIG开放的API 配置APIG的API认证凭据 常见问题 了解更多常见问题、案例和解决方案
x-apigateway-response 含义:API的网关响应名称。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: x-apigateway-response: test
页面底部,您将看到所需的配置费用。 图1 按需计费配置费用示例 配置费用包括版本、公网带宽、实例数以及使用时长。 计费周期 按需计费时,实例按秒计费,每一个小时整点结算一次费用(以GMT+08:00时间为准),结算完毕后进入新的计费周期。计费的起点以部署在API网关上实例启动运行
x-apigateway-responses 含义:自定义网关响应类型。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: x-apigateway-responses: default: ACCESS_DENIED:
x-apigateway-sample 含义: API的请求参数示例值。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters: - maximum:
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
x-apigateway-access-control 含义:引用访问控制策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-access-control:
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。 请求协议配置错误,如后端服务为HTTP,在API网关配置为HTTPS。 创建的API与后端服务配置相同的协议。 API网关客户侧后端服务链接链路不通。 排查链接链路。 父主题: 调用API
查看可用区信息 功能介绍 查看可用区信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/available-zones 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现,选择其中一种配置即可。 方式一:配置一个OPTIONS请求,作为预检请求。预检请求API的参数设置,操作详情请参考非简单请求。 方式二:只需配置一个跨域资源共享策略并绑定API即可,配置详情请参考配置API的跨域资源共享。 在“前端定义”中,参数填写说明如下:
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
x-apigateway-orchestrations 含义: API请求参数的编排规则列表。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters:
x-apigateway-backend 含义:API网关定义的API后端服务定义。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get: produces:
仅在用户后端服务所在的VPC下能够解析。 解决方法 方法一:在创建API时,使用公网域名配置“后端服务地址”。 方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。 方法三:在创建API时,使用VPC通道(负载通道)。
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins:
“条件来源”为“源地址”时,输入一个或多个IP地址,以英文逗号隔开。 (可选)配置后端服务参数。 将调用API时传入的参数映射到后端服务对应的位置。 在“后端服务参数”右侧单击,通过以下任意一种方法配置后端服务参数。 单击“导入入参定义”,系统自动添加已创建的所有入参参数。 单击
无法找到插件配置 联系技术支持 APIG.0105 The backend configurations do not exist. 500 无法找到后端配置 联系技术支持 APIG.0106 Orchestration error. 400 编排错误 检查API配置的前后端参数是否合理
x-apigateway-request-type 含义:API网关定义的API请求类型,支持public和private。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: