检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses
API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义 parameters 否 Object 请求参数对象数组定义,参考表 前端parameters参数说明 responses
特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义
否 String 名称 acl_type 否 String 类型:PERMIT或DENY entity_type 否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1
类型 说明 acl-type 是 String 访问控制行为,支持PERMIT、DENY。 entity-type 是 String 访问控制对象,仅支持IP。 value 是 String 访问控制策略值,多个值以“,”间隔。 父主题: APIG的API设计文件扩展定义
acl_value String ACL策略值,支持一个或多个值,使用英文半角逗号分隔 entity_type String ACL策略约束对象。取值范围: IP DOMAIN (租户名称) 请求消息样例: { "acl_name": "string", "acl_type": "PERMIT"
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String VPC通道的编号。 inst_id 是 String 后端实例对象的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request
否 String 名称 acl_type 否 String 类型:PERMIT或DENY entity_type 否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1
否 Boolean 是否共享流控策略。 special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略。 父主题: APIG的API设计文件扩展定义
本次查询到的云服务器列表。 表4 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id
字典数据类型 云服务器列表。 表6 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id
本次查询到的云服务器列表。 表4 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id
实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String VPC通道的编号。 inst_id 是 String 后端实例对象的编号。 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content 400 Bad Request
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
字典数据类型 云服务器列表。 表6 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1
acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3
全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果。