检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
账号ID:仅适用IAM认证类型的API,限制调用API的账号ID。仅支持配置账号ID,对账号ID及账号ID下的IAM用户ID做限制,不支持配置IAM用户ID。 可以配置单账号ID或多账号ID,多账号ID以英文格式下的“,”隔开。账号ID为英文字母、数字组成的32位字符;多账号ID字符的总长度不超过1024。 说明:
配置API的流量控制 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 使用限制 API添加流控策略相当于流控策略同步绑定了API。同一
配置API的HTTP响应头 API响应是指API网关返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。
查看应用绑定的API详情 操作场景 在应用绑定API后,查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击待查看的API名
在“创建策略”弹窗中,配置策略信息。 表1 跨域资源共享策略配置 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“跨域资源共享”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。
于“~/.bash_history”、“/var/log/messages”(如有)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/statistics/api/latest
删除环境 操作场景 已创建的环境不再提供服务,可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 在待删除的环境所在行,单击“删除”,弹出对话框。 仅在环境未被API发布时,支持删除。 单击“确定”,完成环境管理信息。
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。例如“API01”。 所属分组 默认“DEFAULT”。 URL
签名密钥”。 在“创建策略”弹窗中,配置策略信息。 表1 签名密钥参数说明 参数 说明 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“AES”和“Public Key”。 在实例的配置参数中开启“public_k
单个IP地址调用API次数上限。您可以选择配置实例的“real_ip_from_xff”参数使用X-Forwarded-For头中的IP作为流控的判断依据。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 参数流控配置 参数流控配置开关。开启后,以参数维度进行流控限制。
应头中获取此处配置的头部,传到业务后端。 最大支持配置10个头部。 简易鉴权模式 开关开启后,鉴权服务返回状态码“2xx”时,表示认证通过。 鉴权结果匹配 仅在“简易鉴权模式”关闭后可配置。 根据鉴权服务返回的响应头中的参数名和参数值进行校验,响应头中存在此处配置的参数名,并且参数值相等则认证通过。
删除签名密钥 操作场景 如果某一个密钥不再提供服务,则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,弹出对话框。 在待删除的密钥所在行,单击“删除”。 单击“密钥名称”,进
已创建的VPC通道不再需要时,可以直接删除。 如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 通过以下任意一种方法,弹出对话框。 在待删除的VPC通道所在行,单击“删除”。
而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 单击“查看更
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,在待删除的自定义认证所在行,单击“删除”,弹出对话框。 单击“确定”。 父主题:
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
虚拟私有云(Virtual Private Cloud,简称VPC)。实例需要配置虚拟私有云(负载),在同一负载中的资源(如ECS),可以使用实例的私有地址调用API。 在创建实例时,建议配置和您其他关联业务相同负载,确保网络安全的同时,方便网络配置。 创建实例后,不支持修改虚拟私有云(负载)。 弹性公网IP
of strings 可用区列表。 可用区指在同一地域下,电力、网络隔离的物理区域,可用区之内内网互通,不同可用区之间物理隔离。选择多个AZ部署可以有效提升可靠性。 获取方法:通过文档中实例管理的可用区列表接口查询。 bandwidth_size 否 Integer 出公网带宽 实
删除应用 操作场景 已创建的应用不再提供服务,可以将应用删除。 从云商店购买的API生成的应用,不支持删除。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 通过以下任意一种方式,进入对话框。 在待删除的应用所在行,单击“删除”。