检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-request-type 含义:API网关定义的API请求类型,支持public和private。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
page_size, page_no, sign_id, env_id, api_id, api_name, group_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:sign_id、env_id、api_id、api_name、group_
页面。 查看此分组下已购买的API列表和此分组的详细信息。 图2 已购买API的分组详情示例 在待调试API所在行,单击“调试API”,跳转到“调试API”页面。 左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。 表1
查看监控指标 操作场景 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API分组和分组内的API。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。
类型 说明 api_id 是 String API的id duration 是 String 最近统计时长,单位必须为h和m,比如1h和1m,分别代表最近1小时和最近1分钟 响应消息 表3 参数说明 参数 类型 说明 操作类型 code String 响应码 R msg String
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits
PI网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。
是否必选 类型 说明 x-apigateway-match-mode 是 String API匹配模式,支持SWA和NORMAL。 SWA:前缀匹配,如“/prefix/foo”和“/prefix/bar”都会被“/prefix ”匹配,但“/prefixpart”却不会被匹配。 NOR
vpc_instances 字典数据类型 本次查询到的云服务器列表。 表4 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。
指定应用能够调用API。 仅在API发布到环境后,才支持被授权。 仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。
导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 导入API前,您需要在导入的API定义文件中补全Swagger扩展定义。如果“扩展定义”中未包含需要的定义,请提前在API网关中创建。 导入API前,请确保API分组和API的配额满足需求。
签名前准备 获取签名密钥信息: 在APIG实例控制台选择“API管理 > API策略 > 策略管理”,单击签名密钥名称进入详情页面,在“策略内容”区域查看Key和Secret。 父主题: 对后端服务进行签名
page_no, throttle_id, group_id, env_id, api_id, api_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:group_id、env_id、throttle_id、api_id、ap
专享版-实例标签管理 查询项目下所有实例标签 查询单个实例标签 批量添加或删除单个实例的标签 查询包含指定标签的实例数量 通过标签查询实例列表 父主题: 专享版API(V2)
专享版-实例特性管理 实例配置特性 查看实例特性列表 查询实例支持的特性列表 父主题: 专享版API(V2)
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 oas_version 否 String OpenAPI版本
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name
删除后端实例 功能介绍 删除指定VPC通道中的后端实例 引用负载通道类型的负载通道不支持删除后端实例。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/
当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统策略——流量控制,从API、用户、凭据、源IP等多个维度进行流控。 然而,随着用户多样性以及需求多样性的增加,传统流控策略无法满