检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
host 否 String VPC通道代理主机 description 否 String API后端描述 表20 后端functionEndpoints参数说明 名称 是否必选 参数类型 说明 function-urn 是 String 函数URN地址 version 是 String
能否针对VPC通道(负载通道)内的ECS私有IP进行访问控制 不支持。 父主题: API安全
凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 绑定凭据配额策略 绑定访问控制策略
BACKEND:后端 不支持修改 authorizer_type String 只能为:FUNC authorizer_uri String 函数地址。 network_type String 对接函数的网络架构类型 V1:非VPC网络架构 V2:VPC网络架构 缺省值:V1 authorizer_version
GET POST PUT DELETE HEAD PATCH OPTIONS ANY CRU 是 req_uri String API的访问地址,不含域名、端口号、请求协议等,是URI CRU 是 auth_type String API的认证方式 NONE:无认证 APP:APP认证
从X-Forwarded-For头中获取IP。例如到达API网关的X-Forwarded-For头中依次有IP1,IP2,IP3 三个IP地址,xff_index取0时获取IP1,xff_index取1时获取IP2,xff_index取-1时获取IP3。 -1 int32有效值 app_route
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
ACL策略管理 对象模型 创建ACL策略 修改ACL策略 删除ACL策略 批量删除ACL策略 查看ACL策略详情 查看ACL策略列表 父主题: 共享版API(仅存量用户使用)
法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 客户端必须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时
Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求
GET POST PUT DELETE HEAD PATCH OPTIONS ANY CRU 是 req_uri String API的访问地址,不含域名、端口号、请求协议等,是URI CRU 是 auth_type String API的认证方式 NONE:无认证 APP:APP认证
源IP流量限制 单个IP地址调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 参数流控配置
描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 身份来源 设置用于认证的请求参数,支持添加Header参数和Query参数,其中Header的参数名不区分大小写。
BACKEND:后端 不支持修改 authorizer_type String 只能为:FUNC authorizer_uri String 函数地址。 network_type String 对接函数的网络架构类型 V1:非VPC网络架构 V2:VPC网络架构 缺省值:V1 authorizer_version
PI网关跨VPC开放后端服务。 公网调用API失败时,可能的原因如下: API没有绑定弹性公网IP(EIP),导致API缺少公网访问的有效地址,公网调用API失败。 绑定EIP后重新调用即可,详细步骤请参考网络环境准备。 入方向规则配置有误,导致公网调用API失败。 配置入方向规则的详细步骤请参考网络环境准备。
查看ACL策略列表 功能介绍 查询所有的ACL策略列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/acls 表1 路径参数 参数 是否必选 参数类型 描述 project_id
VPC通道中主机的端口号。 balance_strategy Integer 分发算法。 1:加权轮询(wrr) 2:加权最少连接(wleastconn) 3:源地址哈希(source) 4:URI哈希(uri) create_time Timestamp VPC通道的创建时间。 vpc_health_config
调用API(浏览器)示例 由于浏览器限制从页面脚本内发起跨域请求,因此浏览器访问API前需要在API网关控制台上创建一个跨域共享策略,允许浏览器向跨域服务器发送XMLHttpRequest请求,并为跨域共享策略绑定API。 创建策略请参考跨域共享策略说明,绑定API请参考为策略绑定API。 图8
req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String
balance_strategy type = 2时必选 Integer 分发算法。 1:加权轮询(wrr) 2:加权最少连接(wleastconn) 3:源地址哈希(source) 4:URI哈希(uri) 仅VPC通道类型为2时有效,缺省为1。 vpc_health_config type = 2时必选