检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 配置后端信息后,单击“下一步”。 表8 HTTP/HTTPS类型定义后端服务 参数 配置说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法:接口调用方式,此处选择“GET”。
输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 time_unit 是 String 流控的时间单位:
是否必选 参数类型 说明 title 是 String API分组名称 version 否 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型 说明 uri 是
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/signs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
解除绑定 功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/sign-bindings/{id} URI中的参数说明如下表所示。
查询App Code列表 功能介绍 查询App Code列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes[?page_size
“系统参数-前端认证参数”策略条件将API请求转发到指定的后端服务中。 约束与限制 添加策略后端前,前端的安全认证方式应选“自定义认证”或使用双重认证(APP认证或IAM认证)。 添加策略后端前,必须定义一个默认后端,不满足任何一个策略后端的API请求,都将转发到默认的API后端。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/api-groups/{id}
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI H
查询环境列表 功能介绍 查询符合条件的环境列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/envs[?page_no, page_size,name] 可以在URI后面用‘
删除签名密钥 功能介绍 删除指定的签名密钥。 删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id}
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/publish[
API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id group_id/group 是 String API分组ID,目前支持group_id和group,两个均存在时以group_id为准,建议使用group_id define 否 String 导出API的定义范围:
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/publish/{api_id}[
查询变量列表 功能介绍 查询分组下的所有环境变量的列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables[?page_size, page_no
开启重定向 开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。 验证重定向 验证重定向功能是否生效。 父主题: 使用APIG专享版实现http到https自动重定向
API的响应结果显示“200 OK”,但是返回值为“默认后端”,表示此时调用的是API的默认后端。否则,请参考错误码章节处理。 父主题: 使用APIG专享版实现不同后端服务的调用
应用场景 API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)
开放CCE工作负载支持以下两种方式,推荐使用方式一直接创建负载通道的方式开放CCE工作负载: 方式一 在API网关中直接创建负载通道,通过负载通道访问CCE工作负载中的实例地址,动态监测工作负载下实例IP地址变化。开放API时使用负载通道访问后端服务,通过API的形式将云容器应用的服务能力开放出来。