PowerScale:如何使用 curl 命令验证 OneFS API 是否正常工作
Summary: 本知识库文章可用于使用 curl 命令直接针对群集对应用程序编程接口 (API) 问题进行故障处理。使用它来排除自定义脚本或应用程序代码的问题。
This article applies to
This article does not apply to
This article is not tied to any specific product.
Not all product versions are identified in this article.
Instructions
简介
当您遇到 OneFS API 问题时,请在执行其他故障处理之前,通过运行 curl 命令来验证基本作是否正常工作。本文提供有关使用 curl 命令测试 API作的说明。它有助于验证您正在运行的命令的格式是否正确。
OneFS API 由两个功能区组成:
- 系统配置 API (在 OneFS 7.1.0 及更早版本中称为平台 API)
此区域启用群集配置、管理和监视功能。
- 文件系统访问 API (在 OneFS 7.1.0 及更早版本中称为对命名空间 API 的 RESTful 访问或 RAN API)
此区域允许对群集中的文件和目录执行作。
流程
在测试系统配置 API 或文件系统访问 API 时, 将 curl 命令与 “root” 凭据配合使用。
- 在群集中的任意节点上建立 SSH 连接,并使用“root”帐户登录。
- 使用 curl 命令,如下面的 系统配置 API 或 文件系统访问 API 部分中所述。
- 如果您仍然遇到问题,请联系 Isilon 技术支持。
有关 curl 命令和语法的其他信息,请参见 curl 手册页。
有关 OneFS 系统配置 API 请求和预期响应的其他信息,请参阅相应 OneFS 版本的 API 参考指南。最常见的 OneFS 版本的链接:OneFS 8.2.2.0、OneFS 9.1.0、 OneFS 9.5.0.0 和 OneFS 9.7.0.0
系统配置 API
curl 与系统配置 API 的常见选项
| 选项 | 描述 |
|---|---|
| -d | 在 POST 请求中发送指定的数据 |
| -H | 指定要使用的额外标头 |
| -k | 允许连接到不受信任的 SSL 站点(适用于 Isilon 默认自签名 SSL 证书) |
| -u | 用于身份验证的用户名 运行命令时,系统会提示您提供此用户的密码 |
| -v | 指定详细输出 |
| -X | 指定请求方法(GET、 PUT、 POST 等) |
curl 与系统配置 API 的常见用法
以下是常见 curl 命令的示例。对于您想要执行的作,请遵循类似的语法。
- 检索信息(GET 命令):
一般语法:使用以下命令,其中 <username> 是用户名, <URL> 是要连接到的节点的 URL。# curl -vk -u "<username>" -H 'Content-type:application/json' -X GET '<URL>'
例如,要获取服务器消息块 (SMB) 共享的列表,该命令会类似于以下内容:# curl -vk -u "root" -H 'Content-type:application/json' -X GET 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'
- 发送信息(POST 或 PUT 命令):
一般语法:使用以下命令,其中 <username> 是用户名, <json-data> 是 JSON 格式的字符串, <URL> 是要连接到的节点的 URL。# curl -vk -u <username> -H 'Content-type:application/json' -X POST -d '<json-data>' <URL>
例如,要创建名为 papi-example 且路径为 /ifs/papi-example 的新 SMB 共享,该命令会类似于以下内容:# curl -vk -u root -H "Content-type: application/json" -X POST -d '{ "name" : "papi-example", "path" : "/ifs/papi-example" }' 'https://10.11.1.1:8080/platform/1/protocols/smb/shares'
文件系统访问 API
具有文件系统访问 API 的 curl 的常见选项
| 选项 | 描述 |
|---|---|
| -d | 在 POST 请求中发送指定的数据 |
| --data-binary | 指定二进制文件的位置 |
| -H | 指定要使用的额外标头 |
| -k | 允许连接到不受信任的 SSL 站点(Isilon 默认自签名 SSL 证书)。 |
| -u | 用于身份验证的用户名,系统会提示您提供此用户的密码。 |
| -v | 指定详细输出 |
| -X | 指定请求方法(GET、 PUT、 POST 等) |
curl 与文件系统访问 API 的常见用法
以下是常见 curl 命令的示例。请遵循类似的语法来执行作。
注意
您可以通过文件系统访问 API 创建自己的命名空间,但应使用默认命名空间进行验证。默认命名空间为 /namespace/ifs。
- 检索信息(GET 命令):
一般语法:# curl -vk -u "<username>" -X GET 'https://<node_IP>:8080/namespace/<access_point>'
例如,要获取 /ifs 的内容列表,请执行以下作:# curl -vk -u "root" -X GET 'https://10.11.1.1:8080/namespace/ifs'
- 发送信息(POST 或 PUT 命令):
常规语法:使用正确的变量 <内容标头>使用以下命令。有关内容标头>的信息<,请参阅 OneFS API 参考指南# curl -vk -u "<username>" -H "<content header>" --data-binary @<source file path> -X PUT 'https://<node_IP>:8080/namespace/<access_point>/<destination file path>'
例如,要将数据文件从 /tmp/testfile.jpg 复制到 /ifs/papi-example,命令会类似于以下内容:
# curl -vk -u "root" -H "x-isi-ifs-target-type:object" --data-binary @/tmp/testfile.jpg -X PUT 'https://<node_IP>:8080/namespace/ifs/papi-example/testfile.jpg'
上述所有命令都使用基本 HTTP 身份验证来运行 API 查询。
Affected Products
PowerScale OneFSProducts
PowerScale OneFSArticle Properties
Article Number: 000011287
Article Type: How To
Last Modified: 08 Oct 2025
Version: 8
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.