检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses
HTTPS,同一个服务的Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。
instance_id Integer 特殊对象的身份标识 instance_name String 作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time
instance_id Integer 特殊对象的身份标识 instance_name String 作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time
instance_id Integer 特殊对象的身份标识 instance_name String 作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time
VPC通道的编号 member_id 是 String 后端实例对象的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
缺省值:DISABLE 表7 BackendApi 参数 参数类型 描述 authorizer_id String 后端自定义认证对象的ID url_domain String 后端服务的地址。 由主机(IP或域名)和端口号组成,总长度不超过255。格式为主机:端口(如:apig.example.
VPC通道的创建、更新、删除、查看,查询VPC通道列表。 后端实例的添加、查看、删除。 后端服务器状态的批量修改。 VPC通过健康检查的修改。 后端服务器组的添加、更新、删除、查看,查询VPC通道后端服务器组列表。 监控信息查询 包括查询最近一段时间的API统计信息,查询最近一小时内的分组统计信息。
instance_id Integer 特殊对象的身份标识 instance_name String 作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time
如果不配置SSL证书,将无法保障请求的链路安全,请谨慎配置。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:客户端与服务端连接时,除了客户端需要验证所连接的服务器是否正确之外,服务端也需要验证接入的客户端是否正确。 约束与限制 仅支持添加pem编码格式的SSL证书。
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
x-apigateway-plugins 含义:API网关定义的API插件服务。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-plugins:
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_size
String 微服务引擎名称 service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本,已废弃,通过后端服务器组中的版本承载。
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-backend.functionEndpoints 含义:API网关定义的FUNCTION类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
IP地址/域名可以是公网IP(支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址)/公网域名,前提需要开启实例的公网出口。可以是内网的IP,不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。 路径 后端服务的路径,即服务的uri,
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id String 子网的网络ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制
特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义