检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
流控策略管理 对象模型 创建流控策略 修改流控策略 删除流控策略 查看流控策略详情 查询流控策略列表 父主题: 共享版API(仅存量用户使用)
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 URI HTTP/HTTPS请求方法以及URI如下表所示。
warning:表示操作失败。 incident:表示比操作失败更严重的情况,例如引起其他故障等。 企业项目ID:输入企业项目ID。 访问密钥ID:输入访问密钥ID(包含临时访问凭证和永久访问密钥)。 时间范围:可选择查询最近1小时、最近1天、最近1周的操作事件,也可以自定义最近7天内任意时间段的操作事件。
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
access the API. 403 IP地址不允许访问 检查IP地址是否被API的访问控制限制。 APIG.0403 The IP address cannot be accessed. 403 IP地址不允许访问 检查IP地址是否被实例级访问控制限制。 APIG.0404 Access
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 strategy_id 是 String 特殊配置的编号
目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。 委托名称 用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。
查看后端实例列表 功能介绍 查看指定VPC通道的后端实例列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 共享版API(仅存量用户使用)
部分IP请使用访问控制策略。 步骤二:创建实例 进入购买实例页面。 根据下表配置实例信息。 表2 配置实例信息 参数 配置说明 计费模式 实例的收费方式,此处选择“按需计费”。 区域 选择实例所属区域,请根据实际需要选择。此处选择“华东-上海一”。 可用区 选择实例的可用区,此处选择“可用区1,可用区2,可用区3”。
default”。 委托名称 用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。 运行时 此处以python2.7语言为例。 单击“创建函数”。 函数创建完成后,进入函数详情。 函数代码需要满足如下条件: 函数代码只支持您自定义的用户数据,且格式为:event["user_data"]。
说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true:支持。 false:不支持。 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 app_code_id 是 String APP Code编号 请求参数
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
删除App Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/