检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略,将x-apigateway-ratelimit属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为您的租户名称, 而非“www.exampleDomain.com”之类的网络域名。 URI HTTP/HTTPS请求方法以及URI如下表所示。
访问控制行为,支持PERMIT、DENY。 entity-type 是 String 访问控制对象,仅支持IP。 value 是 String 访问控制策略值,多个值以“,”间隔。 父主题: APIG的API设计文件扩展定义
API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、中文或数字开头,长度为3~255个字符。 API路径 API的请求路径。请求路径可以包含请求
增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。 URI HTTP/HTTPS请求方法以及URI如下表所示。
String 特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义
group_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:api_id、api_name、group_id 、group_name 、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选
ance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数
ance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
分组上可以绑定的自定义域名个数限制 API_VERSION_NUM_LIMIT:每个API可以保留的发布版本个数限制 VPC_NUM_LIMIT:租户可以创建的VPC通道个数限制 VPC_INSTANCE_NUM_LIMIT:每个VPC通道上可以绑定的弹性云服务器个数限制 API
String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表1 参数说明 参数 是否必选 类型 说明 customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。
String ACL策略值 entity_type String ACL策略作用的对象类型: IP DOMAIN ADMIN env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id String 绑定关系编号 bind_time Timestamp
导出API 参数 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:包括API前端请
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表
String ACL策略值 entity_type String ACL策略作用的对象类型: IP DOMAIN ADMIN env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id String 绑定关系编号 bind_time Timestamp