检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对API的修改是否需要重新发布? 需要。 API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 关于API重新发布的详细指导,请参考发布API。 父主题: API发布
实例的入口地址,并添加证书。添加域名后,还需执行放行回源IP、本地验证、修改域名DNS解析设置。详细操作步骤请参考网站接入WAF(云模式)。 如果WAF与APIG在同一VPC下,“源站地址”可以填写私网地址。 如果APIG绑定弹性IP,“源站地址”可以填写公网地址。 在APIG实
instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 create_time Timestamp 云服务器增加到VPC通道的时间。 响应消息样例:
其CNAME解析到API分组对应的子域名;对于专享版,您需要将其A记录解析到实例的入口地址。解析成功后,即可使用。域名与API分组为多对一的关系,即一个分组最多能绑定5个独立域名,但一个域名只能解析到1个分组。 如果您使用的公网域名,需要在DNS服务公网解析内注册CNAME记录(共享版)/A记录(专享版)。
Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1
后端服务是否支持绑定私网ELB地址? 专享版支持绑定私网ELB地址。 共享版不支持绑定私网ELB地址,请使用VPC通道。 如果是公网ELB地址,可直接使用。 父主题: API创建
配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份? 认证方式不能基于某个特殊场景进行选择性认证。 方案1:创建API时选择无认证方式,然后利用“访问控制策略”功能进行IP白名单过滤,使得所有调用都不需要校验身份。 方案2:考虑拆分成2个API,其中一个使用
修改变量 功能介绍 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/env
$context.serverAddr:网关的服务器地址 $context.serverName:网关的服务器名称 $context.handleTime:本次API调用的处理时间 $context.providerAppId:API拥有者的应用对象ID,暂不支持使用 前端认证参数取值:以“$context
详细的使用指导,可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API,作为预检请求。 预检请求API的参数设置,请参考以下说明填写。详细的使用指导可参考非简单请求。 在API的基本信息中,安全认证选“无认证”。
浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。如需自定义跨域的请求头、跨域的请求方法和指
出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见开启跨域访问。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活的实现API的跨域访问。
是 String API的编号,可通过查询API信息获取该编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 group_id 否 String API所属分组的编号,该值不可修改 name 是 String API名称 长度为3 ~ 64位的字符串,字符串由中文、英文
String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1:可用 2:不可用 port Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id String 后端云服务器的编号。
检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 > 实例信息”界面开启出口地址。 检查VPC网络中的ACL配置,查看是否有相
修改API 功能介绍 修改指定API的信息,包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI