检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
约束与限制 基于APIG共享版使用了云商店功能暂不支持迁移。 基于APIG共享版使用了跨用户授权功能暂不支持迁移。 基于APIG共享版使用了ELB通道类型的VPC通道暂不支持迁移。 由DataArts创建的共享版资源需要由DataArts服务提供迁移。 涉及以上特殊场景的用户,可提交工单联系技术支持工程师协助处理。
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
配置API认证凭据访问控制 绑定访问控制策略可控制访问API的客户端(API调用者)IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理
最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述
添加或更新后端实例 功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST
批量修改后端服务器状态可用 功能介绍 批量修改后端服务器状态可用。 引用负载通道类型的负载通道不支持修改后端服务器状态可用。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-
批量修改后端服务器状态不可用 功能介绍 批量修改后端服务器状态不可用。 引用负载通道类型的负载通道不支持修改后端服务器状态不可用。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/v
自定义API响应的响应头信息。 单击“添加header参数”,并填写参数名、参数值和参数描述。 如果“后端请求Path”中设置了环境变量,在API调试页面将无法调试API。 如果“后端请求Path”中设置了环境变量,则必须在待发布环境上配置变量名和变量值,否则变量无法赋值,API将无法正常调用。 环境变量名严格区分大小写。
选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。 Pod标签相关内容指导,请参考设置标签与注解。 服务标识值 标签 选择工作负载的Pod标签。如果服务标识名和服务标识值不唯一,且不能指定某个工作负载时,还可以通过选择其他Pod标签指定某个工作负载。
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? API可以绑定内网域名吗? 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published
方式中选择配置: / /{包名}.{服务名} /{包名}.{服务名}/{方法名} 包名、服务名、方法名从proto文件中获取。 当前端路径设置“/{包名}.{服务名}/{方法名}”时,API的匹配模式才可以使用“绝对匹配”。 不支持Base64编码配置。 安全配置请参考5.b。 单击“下一步”。
关闭实例公网入口 功能介绍 关闭实例公网入口,仅当实例为ELB类型时支持 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型
推荐使用HTTPS。 负载通道(可选) 仅在“使用”负载通道时,需要设置。选择已创建的负载通道名称,如果没有可选的负载通道,您也可以单击“新建负载通道”创建。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 填写鉴权服务的访问地址,格式:“主机:端口”。主机为鉴权服务的访
更新实例入公网带宽 功能介绍 更新实例入公网带宽,仅当实例为ELB类型时支持 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型
开启实例公网入口 功能介绍 开启实例开启公网入口,仅当实例为ELB类型时支持 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型
更新后端实例 功能介绍 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组,则进行全量覆盖。 引用负载通道类型的负载通道不支持更新后端实例。 调用方法 请参见如何调用API。 URI PUT /v2/{p
更新VPC通道后端服务器组 功能介绍 更新指定VPC通道后端服务器组。当负载通道为nacos微服务类型时,不支持修改服务器组权重。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/vp
公网访问是否支持IPv6。 当前仅部分region部分可用区支持IPv6 loadbalancer_provider 否 String 负载均衡器类型: lvs elb tags 否 Array of TmsKeyValue objects 标签列表。 一个实例默认最多支持创建20个标签 数组长度:0
仅在协议不为“TCP”时,需要设置。 检查端口 健康检查的目标端口。 缺省时为VPC中主机的端口号。 正常阈值 判定VPC中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。 取值为2 ~ 10。缺省时为2。 异常阈值 判定VPC中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。 取值为2
授权时,“作用范围”需要选择“区域级项目”,然后在指定区域(如北京1)对应的项目(cn-north-1)中设置相关权限,并且该权限仅对此项目生效;如果在“所有项目”中设置权限,则该权限在所有区域项目中都生效。访问API网关服务时,需要先切换至授权区域。 权限根据授权精细程度分为角色和策略,策略是角色的升级版。