检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI H
String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明
创建API 创建API,后端服务地址配置ELB的IP。 创建ECS 选择VPC2为其VPC,并在其上部署后端应用服务,创建Elastic Cloud Server(应用服务器)。 调试API 验证对接内网ELB是否成功。 父主题: 使用APIG专享版跨VPC开放后端服务
存量用户进入共享版控制台操作如下。 登录API网关控制台页面。 在“总览”页面的右上角单击“进入共享版控制台”,进入共享版页面。 父主题: 共享版操作指导(仅存量用户使用)
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls/{id}
后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。 instance_id String 后端实例的ID。 host String 后端实例的主机地址 weight
增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为您的租户名称, 而非“www.exampleDomain.com”之类的网络域名。 URI HTTP/HTTPS请求方法以及URI如下表所示。
更新SSL证书不影响API的调用。 如果待更新证书已绑定独立域名,那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书,那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证;如果更新的SSL证书已绑定独立域名且更新的内容无CA
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义
API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https) 约束与限制
响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号 env_id
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
功能介绍 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。
响应消息 表4 参数说明 参数 类型 说明 id String 签名密钥的编号 name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 create_time Timestamp 创建时间 update_time
功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/sign-bindings/{id} URI中的参数说明如下表所示。 表2 参数说明
将防护域名注册到DNS服务上。 绑定防护域名 将防护域名绑定到API分组上。 创建API 在绑定域名的分组上创建一个API。 验证 调用API,调用成功表示对接DDoS成功。 父主题: 使用DDoS防护服务为APIG抵御DDoS攻击
删除签名密钥 功能介绍 删除指定的签名密钥。 删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id}
success Array 发布或下线成功的信息 failure Array 发布或下线失败的API及错误信息 表5 success参数说明(批量发布) 名称 类型 说明 publish_id String 发布记录的ID api_id String 发布成功的API ID api_name
instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 create_time Timestamp 云服务器增加到VPC通道的时间。 响应消息样例: