导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances
查询API分组概况 功能介绍 查询租户名下的API分组概况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groups 表1 路径参数 参数 是否必选
查询APP列表 功能介绍 查询APP列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查看可用区信息 功能介绍 查看可用区信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/available-zones 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目
查询监控数据 功能介绍 查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1
实例解绑EIP 功能介绍 实例解绑EIP 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询分组详情 功能介绍 查询指定分组的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述
添加特殊应用或租户 操作场景 如果需要为某个应用/租户设置特定的流控值,则通过添加特殊应用/租户可以实现。 前提条件 已创建应用,或已获取其他应用ID/租户ID。 添加特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待添加特殊应用的流控策略的名称
删除特殊应用或租户 操作场景 在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特殊应用的流量控制策略的名称
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。
创建并使用签名密钥 操作场景 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息
重置AppSecret 操作场景 AppKey唯一且不可重置,AppSecret支持重置,将AppSecret的值重新改变。重置完成后,原先的AppSecret将失效,绑定此应用的API将无法调用,请更新AppSecret,并重新调用API。 前提条件 已创建应用。 操作步骤 进入共享版控制台
查看应用绑定的API详情 操作场景 在应用绑定API后,查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击待查看的API名称
创建访问控制策略 操作场景 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的
删除访问控制策略 操作场景 当已创建的访问控制策略不再需要时,可以将此访问控制策略删除。 前提条件 已创建访问控制策略。 操作步骤 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 通过以下任意一种方式,弹出“删除访问控制策略”对话框。 在待删除的访问控制策略所在行
配置API的后端服务签名校验 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息
配置API的流量控制2.0 流量控制2.0策略可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。 基础流控 可以对API、用户、凭据、源IP进行多维度流控,与已有的配置API的流量控制功能一致但不兼容。 参数流控 支持根据Header、Path、
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors
x-apigateway-ratelimit 含义:引用流控策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-ratelimit
x-apigateway-ratelimits 含义:流控策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit