检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
(一个API同时绑定IP类型和账号名/账号ID类型的访问控制策略,这两种类型的判断逻辑与三种类型的判断逻辑相同)。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止指定的IP地址/账号名/账号ID访问API。 IP地址 仅当“类型”为“IP地址”时需要配置。
是 Object 响应定义,参考表9 security 否 Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend
String 对应的请求参数编号 name String 参数名称 location String 参数位置 origin String 参数类别 value String 参数值 remark String 描述 表9 policy_https参数说明 参数 类型 说明 id
当扩展信息定义冲突时,merge保留原有扩展信息,override会覆盖原有扩展信息。
acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数
String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间
表2 参数说明 参数 参数位置 是否必选 类型 说明 extend_mode query 否 String 扩展信息导入模式,可选merge和override。 当扩展信息定义冲突时,merge保留原有扩展信息,override会覆盖原有扩展信息。
entity_type 是 String 对象类型: IP:IP地址 DOMAIN:账号名 DOMAIN_ID:账号ID 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 acl_name String 名称 acl_type String 类型: PERMIT
san 字典数据类型 SAN域名 version String 证书版本 organization 字典数据类型 公司、组织 organizational_unit 字典数据类型 部门 locality 字典数据类型 城市 state 字典数据类型 省份 country 字典数据类型
String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明
表3 请求Body参数 参数 是否必选 参数类型 描述 app_acl_type 是 String 类型 PERMIT (白名单类型) DENY (黑名单类型) app_acl_values 是 Array of strings ACL策略值,支持IP、IP范围和CIDR方式。
是 Object 响应定义,参考表10 security 否 Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend
String 证书版本 organization 字典数据类型 公司、组织 organizational_unit 字典数据类型 部门 locality 字典数据类型 城市 state 字典数据类型 省份 country 字典数据类型 国家 not_before Timestamp
是 Object 响应定义,参考表9 security 否 Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend
2:服务器类型 3:微服务类型 当vpc_channel_type字段为空时,负载通道类型由type字段控制: 当type不为3或microservice_info为空,VCP通道类型默认为服务器类型。
当vpc_channel_type不为空,但type字段非空或不为0时,当vpc_channel_type的指定类型与type字段指定的类型冲突时会校验报错。
表8 前端parameters参数说明 名称 是否必选 参数类型 说明 maximum 否 Float 参数为数值类型时,最大参数值 minimum 否 Float 参数为数值类型时,最小参数值 maxLength 否 Integer 参数为字符串类型时,参数的最大长度 minLength
String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间
vpc_health_config type = 2时必选 字典数据类型 健康检查详情,仅VPC通道类型为2时有效。 vpc_instances 是 字典数据类型 后端实例列表,VPC通道类型为1时,有且仅有1个后端实例。
type 是 Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type type = 2时必选 String VPC通道的成员类型。 ip(暂不支持) instance 仅VPC通道类型为2时有效,缺省为instance。