检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
时,可同步创建API分组。具体步骤请参见通过CCE工作负载导入API。 实例创建后,有一个DEFAULT分组,可直接通过虚拟私有云地址调用默认分组中的API。 约束与限制 一个API只能属于一个API分组。 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名
中文字符必须为UTF-8或者unicode编码。 req_method String API请求方法 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 状态码: 400 表6 响应Body参数 参数 参数类型
否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息
String API编号 req_uri String API的请求地址 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 type Integer API类型 signature_name
API编号 api_name 否 String API名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 total Integer 符合条件的API总数
限制。 定义参数 定义用于规则匹配的参数。 参数位置:用于规则匹配的参数位置。 path:API请求的URI,系统默认配置。 method:API请求方法,系统默认配置。 Header:请求头的key值。建议不要设置敏感信息,以防泄露。 Query:QueryString的key值。
API编号 api_name 否 String API名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 total Integer 符合条件的API总数
timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 address 是 Array 后端服务地址,格式为:<域名或IP>:[port]。 scheme 是 String 后端请求协议定义,支持http、https。 method 是 String 后端请求方法,支持G
String API编号 req_uri String API的请求地址 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 状态码: 400 表6 响应Body参数 参数 参数类型
AUTHORIZER:自定义认证 match_mode String API的匹配方式。 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配) 默认:NORMAL group_id String API所属的分组编号。 group_name String API所属分组的名称。 attached_time
插件绑定API 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project
网关支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。
在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的默认子域名进行API调试,每天最多可以访问默认子域名1000次。 创建API 把已有后端服务封装为标准RESTFul API,并对外开放。 API创建成功后,您可根据业务需求对API设置访问策略:
String 编号 R - name String 名称 CRU 是 status Integer 状态: 1:启用 2:禁用 3:已删除 默认1 该字段已废弃 R - appkey String APP的key,全局唯一 R - app_secret String 密钥 RU -
String 编号 R - name String 名称 CRU 是 status Integer 状态: 1:启用 2:禁用 3:已删除 默认1 该字段已废弃 R - appkey String APP的key,全局唯一 R - app_secret String 密钥 RU -
流控策略编号 name 否 String 流控策略名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息
策略生效范围 此处选择“单个API生效”,对单个API进行流量统计和控制。 时长 流量限制时长,根据诉求填写60秒。 基础流控配置。 根据1,默认API在60秒内的流量限制为10次,用户流量限制为5次。 表2 基础流控配置 参数 配置说明 API流量控制限制 10 用户流量控制限制 5
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,如果再次绑定同类型的插件,那么已绑定的同类型插件将直接被覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project
@,#,$,%,+,/,=,可以英文字母,数字,+,/开头,16个字符。未填写时后台自动生成。 sign_algorithm String 签名算法。默认值为空,仅aes类型签名密钥支持选择签名算法,其他类型签名密钥不支持签名算法。 update_time String 更新时间 create_time
为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略;一个API在发布到特定环境后只能绑定一个默认的流控策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{in