检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
与直接访问容器应用相比,API网关提供流量控制,确保后端服务稳定运行。 支持多实例负载均衡,合理利用资源,增加系统可靠性。 约束与限制 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。 您需要确保当前实例与CCE集群所属同一个负载通道VPC中,或通过其他方式保证两者网
配置API的第三方认证 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。API网关先调用用户的鉴权服务,收到鉴权服务的鉴权成功响应后再继续调用后端服务。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 第三方认证原理图如下,第三方认证策略绑定API后,您可以参考调用APIG开放的API调用。
_id为实例ID(在APIG控制台的“实例信息”中查看)。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要在“华北-北京四”区
查询分组详情 功能介绍 查询已购买的指定分组的详情。 URI HTTP/HTTPS请求方法以及URI如下表1所示 表1 HTTP/HTTPS请求方法及URI 请求方法 URI GET /v1.0/apigw/purchases/groups/{purchase_id} URI中的参数说明如下表所示。
查询API分组概况 功能介绍 查询租户名下的API分组概况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groups 表1 路径参数 参数 是否必选
description string string maxLength minLength default enum required description 其它类型 不支持 不支持 表3 API请求路径模板语法差异 语法 OAS类型Swagger类型 API网关 /users/{userName}
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/api
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
查询编排规则绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instan
当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret
查询插件详情 功能介绍 查询插件详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。 后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 使用API方式创建环境 您还可以使用API的方式创建环境和变量,具体操作请查看以下链接。 创建环境 新建变量 环境变量相关的FAQ API发布到不同环境后,会调用不同的后端服务吗?
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
包含一个服务名称标签和若干其它标签 服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息
API统计信息查询-最近一段时间 功能介绍 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟、小时、天。 查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一
API统计信息查询-最近一段时间 功能介绍 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。 为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/i
查询可绑定当前插件的API 功能介绍 查询可绑定当前插件的API信息。 支持分页返回 支持API名称模糊查询 支持已绑定其他插件的API查询返回 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance
配置参数提供了实例内组件的公共参数配置,通过修改配置参数,可以调整组件的相关功能。 约束与限制 修改实例配置参数会引起APIG业务中断,建议在无业务运行或业务低峰时修改配置参数。 配置实例参数 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上,单击“查看控制台”或实例名称。 单击