检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
是 String 实例ID,在API网关控制台的“实例信息”中获取。 ingress_port_id 是 String 实例自定义入方向端口ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过
api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
default”。 委托名称 用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。 运行时 此处以python2.7语言为例。 单击“创建函数”。 函数创建完成后,进入函数详情。 函数代码需要满足如下条件: 函数代码只支持您自定义的用户数据,且格式为:event["user_data"]。
查询实例终端节点连接列表 功能介绍 查询实例终端节点连接列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections 表1 路径参数 参数 是否必选
THROTTLE_ID String 流控策略编号,限定该分组在一定时间内可以被访问的次数 说明: 该字段表示该分组下的所有API单位时间内总共能够访问多少次,并非表示每个API单位时间内分别能够访问多少次。 RU - 父主题: API分组管理(待下线)
调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用API网关服务资源。 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。 将API网关服务资源委托给更专业、高效的其他账号或者云服务,这些账号或者云服务可以根据权限进行代运维。
怎样保护API的调用安全? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API网关默认
API请求参数。 域名可选调试域名或独立域名。当选择的独立域名为泛域名时,需要填写泛域名的子域名。 当独立域名为泛域名时,用户可以通过泛域名的所有子域名访问所绑定分组下的所有API。 例如,某个泛域名为“*.aaa.com”,子域名可以为“default.aaa.com”和 “1
THROTTLE_ID String 流控策略编号,限定该分组在一定时间内可以被访问的次数 说明: 该字段表示该分组下的所有API单位时间内总共能够访问多少次,并非表示每个API单位时间内分别能够访问多少次。 RU - 父主题: API分组管理
version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间,单位:毫秒 register_time Timestamp 创建时间
IngressPortInfo objects 实例自定义入方向端口列表。 表5 IngressPortInfo 参数 参数类型 描述 protocol String 实例自定义入方向端口协议。 HTTP:实例自定义入方向端口使用HTTP协议。 HTTPS:实例自定义入方向端口使用HTTPS协议。
API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败
推荐使用高性能流控。 高精度流控:高并发场景下实例内部会有一定的性能损耗,适用于并发量较小的场景。 高性能流控:高并发场景下实例内部性能损耗较小,单位时间内会偶现较小的误差值,适用于并发量较大的场景。 单机流控:实例的每个节点各自进行流控,高并发场景下实例内部性能损耗最小,单位时间内会存在一定的误差值,适用于并发量更大的场景。
开放CCE工作负载 方式一:在API网关中直接创建负载通道并开放API,通过负载通道访问CCE工作负载中的实例地址。 方式二:在API网关中一键式导入CCE工作负载,自动生成API和负载通道,通过负载通道访问CCE工作负载中的实例地址。 (可选)配置工作负载标签实现灰度发布 通过CCE
ML、YML文件的格式导出,支持导出单个API和批量导出API。 导出API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理 > API列表”,单击“导出API”。