检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 OpenAPI版本 选择导出Swagger 2.0或OpenAPI 3.0定义的API。 单击“导
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
标签值:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = + - @字符。 如您的组织已经设定API网关服务的相关标签策略,则需按照标签策略规则为实例添加标签。标签如果不符合标签策略的规则,则可能会导致添加标签失败,请联系组织管理员了解标签策略详情。
户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。 instance_id String 后端实例的ID。 host String 后端实例的主机地址 weight
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 authorizer_list Array of AuthorizerResp
指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。当前仅支持orchestration_name。 orchestration_id 否 String 编排规则编号。 支持指定多个编号作为查询条件,多个参数之间使用“,”隔开,支持的查询参数个数与ap
类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance
id String 后端实例对象的编号 R - vpc_id String VPC通道的编号 CRU 是 ext_vpc_id String 后端实例对象的主机关联的VPC的编号 该字段已废弃 R 是 instance_id String 实例的编号 CRU 否 instance_name
仅在API请求的“请求协议”为“HTTP&HTTPS”时,支持修改。 方法 仅在API请求的“Method”定义为“ANY”时,支持修改。 后缀 仅在API请求的“匹配模式”为“前缀模式”时,支持自定义路径。 路径 API的请求path。 路径参数 仅在API请求的“请求Path”中存在“{}”时,支持修改。
增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。 URI HTTP/HTTPS请求方法以及URI如下表所示。
he-Control,Range 正式请求允许的头域。 Access-Control-Allow-Methods GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH 正式请求允许的方法。 父主题: APIG的API设计文件扩展定义
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1/{pr
访问控制策略的名称。 限制类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。
开通自动续费后,还可以手动续费该实例。手动续费后,自动续费仍然有效,在新的到期时间前的第7天开始扣款。 自动续费的到期前7日自动扣款属于系统默认配置,您也可以根据需要修改此扣款日,如到期前6日、到期前5日等等。 更多关于自动续费的规则介绍请参见自动续费规则说明。 前提条件 请确认包年/包月实例还未到期。
member_group_name 否 String VPC通道后端云服务组的名称 precise_search 否 String 指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。 当前支持member_group_name。 请求参数 表3 请求Header参数
ey才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 sign_key String 签名密钥的key。 hmac类型的签名密钥
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 on_sell_status
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“确定”,API发布成功后,“发布最新版本”按钮左上角的红色感叹号消失。 已发布的API因为其他原因
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。