检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“类型”为“IP地址”时,需要设置。
authorized to access the API. 检查IP地址是否被黑白名单限制。 503 APIC.0404 Access to the backend IP address has been denied. 使用可用的IP地址访问后端服务。 403 APIC.0405 The app
流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 父主题: 安全
通过分发算法确定请求被发送到哪台主机。 分发算法包含如下几种: 加权轮询 加权最小连接 源地址哈希 URI哈希 配置通道内服务器。 创建服务器分组,填写分组名称、权重和描述。 添加后端服务器地址,填写后端服务地址,设置是否启用备用节点。 配置健康检查。 表2 基本信息配置 信息项 描述 协议
{Body} } POST:请求方法,需替换为获取API的请求信息中获取的请求方法。 {Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。
修改服务商信息,修改完成后,单击“立即提交”。 图1 变更服务商信息 在API中心变更的服务商信息不会同步至华为云云商店,在华为云云商店变更的服务商信息也不会同步至API中心。 父主题: 服务商
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明:
名和实际添加证书所用的域名不一致。 转换证书为PEM格式 格式类型 转换方式(通过OpenSSL工具进行转换) CER/CRT 将“cert.crt”证书文件直接重命名为“cert.pem”。 PFX 提取私钥命令,以“cert.pfx”转换为“key.pem”为例。 openssl
HTTP&HTTPS类型定义后端服务 信息项 描述 负载通道 是否使用负载通道访问后端服务。如果选择“使用”,您需要提前创建负载通道。 URL URL地址由请求方法、请求协议、负载通道/后端服务地址和路径组成。 请求方法 GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY,其中ANY表示该API支持任意请求方法。
5%。 在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
选择“不使用”负载通道访问后端服务。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择协议类型,此处选择“HTTP”。 后端服务地址:后端服务的地址。 路径:后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面,定义返回结果。
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明:
制。 访问控制 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据,也支持将多个API授权给同一个凭据。
某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 支持区域: 华北-北京四 访问控制策略说明 签名密钥策略 签名密钥用于后端服务验证A
值”限制,其他凭据调用API次数的上限,仍然受本参数值限制。 源IP流量限制 单个IP地址调用API次数上限。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的IP地址请求次数上限。 描述 关于控制策略的描述。 添加特殊应用 已创建凭据,或已获取其他用户的凭据ID。
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明:
服务商入驻成功后信息还可以修改吗? 可以,API中心支持您修改服务商信息。具体修改方法,参考变更服务商信息章节。 父主题: 服务商入驻
对应API文档,API描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作
API文档记录API接口变更 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 API接口的变更,要具体到参数级别,必须将API修订的记录按照时间和版本顺序排列进行条目化,具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15 V1.0 XXX服务API初始发布
在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 如果想要设置之前版本为当前版本,则在版本所在行,单击“切换至此版本”,弹出“切换至此版本”对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。