检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
最大值:600000 vpc_status 否 Integer 是否使用VPC通道: 1 : 使用VPC通道 2 : 不使用VPC通道 vpc_info 如果vpc_status=1,则这个字典类型为必填信息 字典类型 VPC通道详情 effect_mode 是 String 关联的策略组合模式
String API的编号 R - name String API的名称 CRU 是 group_id String API所属分组的编号 CR 是 type Integer API的类型: 1:公有API 2:私有API CRU 是 status Integer API的状态: 1:启用
String 实例描述 vpc_id String 虚拟私有云ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id
务。角色并不能满足用户对精细化授权的要求,无法完全达到企业对权限最小化的安全管控要求。 策略:IAM最新提供的一种细粒度授权的能力,可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式,能够满足企业对权限最小化的安全管控要求。例如:针对API网关服
String API的编号 R - name String API的名称 CRU 是 group_id String API所属分组的编号 CR 是 type Integer API的类型: 1:公有API 2:私有API CRU 是 status Integer API的状态: 1:启用
x-apigateway-request-type 是 String API类型,支持public和private。 public:公开类型API,可以上架。 private:私有类型API,不会被上架。 父主题: APIG的API设计文件扩展定义
Integer 是否使用VPC通道: 1 : 使用VPC通道 2 : 不使用VPC通道 vpc_info 如果vpc_status=1,则这个字典类型为必填信息 字典类型 VPC通道详情 authorizer_id 否 String 后端自定义认证对象的ID 表5 VPC通道参数说明 参数
每个实例最多可以创建100个访问控制策略。 √ VPC通道(负载通道)数量 每个实例最多创建200个VPC通道。 √ 变量数量 每个分组在任意一个环境中,最多创建50个变量。 √ 独立域名数量 每个分组最多可以绑定5个独立域名。 √ 云服务器数量 每个VPC通道最多添加10个云服务器。 √ 参数数量
目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。建议您按照一定的命名规则填写名称,方便您快速识别和查找。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。
企业为了保护APIG及后端服务器免受恶意攻击,可在APIG和外部网络之间部署WAF。 图1 后端服务器访问原理 方案一(推荐):WAF侧注册对外访问域名并配置证书,通过APIG实例的分组调试域名访问后端服务 推荐原因:API分组通过域名方式对外提供服务,具备更强的可扩展性。 在APIG实例中,新建AP
API请求优先匹配自定义规则中的触发条件和降级策略,仅当未匹配到自定义规则时才执行上方配置的默认触发条件和降级策略。 如果匹配到自定义规则,则执行规则内配置的触发条件和降级策略。如果匹配到的自定义规则内未配置触发条件或降级策略,则执行上方配置的默认触发条件或降级策略。 如果未匹
导入导出API的限制与兼容性说明 在API网关中导入或者导出API时,限制与兼容性如下所示: 限制说明 API网关参数限制,如下所示。 API网关暂不支持formData和body位置的请求参数定义。 API网关暂不支持consumes和produces定义。 API网关中,header位置的参数名称,不区分大小写。
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
authorizer_context_support_num_bool 自定认证返回的context里键值对的值是否支持number类型和boolean类型。 否 - - - - - custom_auth_header APP认证和签名密钥策略是否支持认证头域自定义配置。 是 1:{ "name":
Timestamp 修改时间 remark String 描述 vpc_status String 是否使用VPC通道 vpc_info String VPC通道信息 authorizer_id String 后端自定义认证对象的ID 表5 mock_info参数说明 参数 类型 说明 id
实例ID,可从API网关控制台的专享版实例信息中获取。 env_id/env 是 String API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id group_id/group 是 String API分组ID,目前支持group_id和grou
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi URI中的参数说明如下表所示。 表2
为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义