2 使用 API

本文档中介绍的 Web 服务仅在 LTFS-LE 1.0.4.01 发行版软件中可用。

访问 Web 服务描述语言文件

程序员可以通过 Web 服务描述语言 (Web Services Description Language, WSDL) 1.1 文件获取已安装的 LTFS-LE 软件版本所提供的受支持 Web 服务签名。可以从以下位置访问该文件：

https://server.mydomain.com:7002/LTFS/LTFSLEWS?WSDL

在上面的示例中，server.mydomain.com 是主机名和域名。

对于某些编程实例，您可能需要以下端口名：

port name="LTFSLEWSSoap12HttpPort"

API 函数

LTFS LE Web 服务的后端执行时间各不相同。与卷或操作的状态相关的 Web 服务可以快速返回。不过，某些 Web 服务的执行时间取决于软件无法控制的一些因素。软件无法预测机械因素（如用户操作）。例如，如果卷包含大量文件，则某些 Web 服务（如分配卷服务）可能需要较长的时间。再例如，弹出操作的完成依赖于操作员走近磁带库并从 CAP 中移除卷。

为了解决这些差异，并在所有 Web 服务调用之间提供一致的编程接口，API 服务调用会立即返回。返回的结果将取决于服务的类型。LTFS LE 具有两种类别的 Web 服务：

  • 状态服务

    状态服务允许用户获取卷和磁带机的状态。有关更多信息，请参见"状态服务"。

  • 管理服务

    管理服务是用于管理硬件资源的服务。例如，可使用管理服务加入卷、弹出卷以及使卷联机或脱机。有关更多信息，请参见"管理服务"。

调用 API 函数

管理服务使用包含两个步骤的过程来调用 API 函数并返回结果：

  1. 调用该函数。将立即返回唯一的请求作业 ID。

  2. 调用 getJobStatus 函数并指定步骤 1 中返回的作业 ID。

    这将返回以下作业状态之一：

    • 0（与作业 ID 关联的 Web 服务调用已完成。）

    • 1（与作业 ID 关联的 Web 服务调用仍在进行中。）

    • -1（在系统中未找到使用该作业 ID 的此类 Web 服务调用。）

签名

LTFS-LE Web 服务签名包含每个 SOAP 请求消息格式、SOAP 响应消息格式和 SOAP 故障消息格式。所有 LTFS LE Web 服务仅支持 SOAP 消息。SOAP 消息格式实施 SOAP 1.2 规范。有关每个函数的有效 SOAP 签名，请参阅"状态服务"和"管理服务"。

一般说明

  • 本文档中概述的 Web 服务仅在 LTFS-LE 1.0.4.01 发行版软件中可用。

  • 只能通过 HTTPS 访问所有 Web 服务 API。

  • 使用 WS-Security 时，所有 Web 服务 API SOAP 请求消息在 SOAP 标头中包含一个用户名标记，其中的用户名和密码都是纯文本。

  • username 和 password 仅作为示例在用户名标记中使用。必须使用有效的用户名和密码对其进行替换。

  • SOAP 请求和响应消息中使用的所有数据都是示例数据，仅用于说明 SOAP 请求和响应消息的数据结构。