检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
包年/包月 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
导出APIG的API APIG支持把创建的API以JSON、YAML、YML文件的格式导出,支持导出单个API和批量导出API。 导出API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。
查看VPC通道详情 功能介绍 查看指定的VPC通道详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。
查看VPC通道详情 功能介绍 查看指定的VPC通道详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id}
配置API的HTTP响应头 API响应是指API网关向客户端返回的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
使用APIG专享版开放云容器引擎CCE工作负载操作流程 准备CCE工作负载信息 在通过API网关将容器的工作负载对外开放前,需要在云容器引擎控制台创建CCE集群(VPC网络模型)或Turbo集群。 开放CCE工作负载 方式一:在API网关中直接创建负载通道并开放API,通过负载通道访问CCE工作负载中的实例地址。
配置API的Kafka日志推送 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 约束与限制 同一个环境中,一个API只能被一个Kafka日志推送策略绑定,但
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示。
发布APIG创建的API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 约束与限制 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。
创建自定义认证 功能介绍 创建自定义认证 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1 路径参数 参数 是否必选 参数类型 描述 project_id
修改自定义认证 功能介绍 修改自定义认证 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} 表1 路径参数 参数 是否必选 参数类型
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/ap
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apis/{id}
查看自定义认证详情 功能介绍 查看自定义认证详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} 表1 路径参数 参数 是否必选
删除专享版实例 功能介绍 删除专享版实例 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
删除变量 功能介绍 删除指定的环境变量。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id} 表1 路径参数 参数 是否必选