4 管理服务

管理服务是用于管理存储资源的服务。例如,可使用管理服务加入卷、弹出卷以及使卷联机或脱机。

概述

这些服务需要与解决方案的机械组件通信,响应时间取决于操作类型和机械延迟。管理服务作为异步调用实现。由于管理服务在执行作业之前返回,因此管理服务是异步的。

  • 操作完成后会返回一个程序或作业 ID,调用服务需要调用该 ID 以便在结果可用时获取结果。

  • 当异步服务返回时,作为响应的一部分会提供一个作业 ID。返回码包括:

    • 0(与该作业 ID 关联的 Web 服务调用已完成。)

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

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

  • 实现 Web 服务客户机的程序员需要定期调用 getJobStatus Web 服务(通过向其传递作业 ID)来获取作业的状态。

  • getJobStatus 返回 "0" 后,调用 getJobResult Web 服务以获取服务结果。

完成每个异步 Web 服务所需的时间有所不同。如果机械端发生故障,则后端会超时。本指南提供了有关第三方 Web 服务客户机在超时之前等待的建议最长时间的准则。

有关 getJobStatusgetJobResult 的信息,请参阅"状态服务"

assignVolume

要使用 LTFS-LE 管理卷,必须将卷分配给 LTFS-LE 应用程序。

在将卷分配给 LTFS-LE 时,会自动将该卷置于联机状态并添加到默认卷池。在分配未格式化的卷时,会自动对其进行格式化以便用于 LTFS-LE。

格式

        assignVolume(String[] volsers)

前提条件:

在分配卷之前,确认有可用的兼容磁带机以及卷为脱机、未分配、未在池中以及可用。卷必须存在于磁带库中。

为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 在继续执行之前,确保卷处于所需的状态之一并执行更正操作(如有必要)。

要调用的 LTFS-LE Web 服务:

assignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则现在会将卷分配给 LTFS-LE 软件。如果卷不是 LTFS 格式,则自动将卷格式化为 LTFS 格式。

参数

  • volser 是要分配的卷的卷序列号。输入参数是一个字符串数组,从而可以分配多个卷。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果卷的状态不是脱机、未分配以及从池中移除,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Assigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume SL0010’s inuseStatus is In use.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:assignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:assignVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope   xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:assignVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1220</return>
      </ns2:assignVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume SL0010’s assignedStatus is Assigned</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s assignedStatus is Assigned</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

ejectVolume

该 API 函数从磁带库中弹出一个或多个 LTFS-LE 卷。

考虑到消息大小,LTFS LE 仅支持弹出最多 30 个卷(使用中转槽 (CAP))。弹出操作以四个卷为一组执行,直到完全弹出所有卷。没有超时。这是异步调用。

格式

ejectVolume(String[] volsers,String acs,String lsm,String cap)

前提条件:

确认:卷已最终化和脱机(在弹出之前);有可用的 CAP;ACS 与配置的磁带库相同。为此,将执行以下操作:

  1. 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  2. 如果卷联机并且未在使用中,则最终化卷:

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  3. 如果卷联机,则在执行弹出 API 调用之前使卷脱机:

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

要调用的 LTFS-LE Web 服务链:

ejectVolume([volser1,volser2,...],acs,lsm,cap) 
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则会从磁带库中弹出卷。用户必须在打开 CAP 门之后走向磁带库并检索卷。

参数

  • volser 是要弹出的卷的序列号。

  • acs 是磁带库 ACS 标识符。

  • lsm 是磁带库 LSM 标识符。

  • cap 是用于弹出卷的磁带库 CAP(中转槽)ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果 volser 数组中的一个 volser 为空或 CAP 标识符 (acs,lsm,cap_id) 的一部分缺失或在使用中,则会返回 null 参数。

  • 如果卷的状态不是脱机、未分配以及从池中移除,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Assigned.

  • The volume SL0010’s availableStatus is Available.

  • The volume SL0010’s inuseStatus is In use.

  • ACS 0 is inconsistent with the library acs 7.

建议的超时

这取决于从 CAP(中转槽)中移除卷所花费的时间。

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:ejectVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:ejectVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401  -wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:ejectVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1213</return>
      </ns2:ejectVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault   xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume SL0010’s onlineStatus is Online</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Online</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

enterVolume

该异步调用用于使用 CAP(中转槽)将一个或多个卷加入磁带库。

格式

enterVolume(String acs,String lsm,String cap)

前提条件:

将卷加入 CAP 不需要特定的前提条件。不过,管理员或服务人员必须收集 CAP 标识符(acslsmcap_id),并且在执行该命令之前确保有可用的 CAP 且该 CAP 未在进行操作(暂挂、弹出、加入或审计)。

要调用的 LTFS-LE Web 服务链:

enterVolume(acs,lsm,cap)
getJobStatus(jobId) <poll each 10s until status is complete>
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则会将卷加入磁带库。

参数

  • acs 是磁带库 ACS 标识符。

  • lsm 是磁带库 LSM 标识符。

  • cap 是用于加入卷的磁带库 CAP(中转槽)ID。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

如果任何参数为空,则将抛出 null 异常。下面显示了抛出的异常示例:

  • ACS 4 is inconsistent with the library acs 7.

  • Invalid ACS number.

建议的超时

这取决于管理员将卷加入 CAP 所花费的时间。

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:enterVolume>
         <arg0>3</arg0>
         <arg1>0</arg1>
         <arg2>1</arg2>
      </ns1:enterVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/
oasis-200401-wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:enterVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1212</return>
      </ns2:enterVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text> Invalid ACS number </ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>Invalid ACS number</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

finalizeVolume

使用 finalizeVolume 命令可提交对卷进行的任何更改。此操作通常在使卷脱机以便从磁带库中弹出之前执行。最终化卷会将任何未写入的元数据或未应用的文件删除应用到卷。此操作确保对全局名称空间的操作在物理卷上反映出来。如果在使卷脱机之前未能最终化卷,则可能会使卷脱机延迟。

格式

finalizeVolume(String volser)

前提条件:

在最终化卷之前,确认有可用的兼容磁带机以及卷为联机、在池中、空闲以及可用。为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 在继续执行之前,确保卷处于所有所需的状态并执行更正操作(如有必要)。

要调用的 LTFS-LE Web 服务:

finalizeVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则已将需要应用至卷的所有暂挂操作应用至卷。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

参数

  • volser 是要最终化的卷的卷序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果卷的状态不是脱机、未分配以及从池中移除,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Offline.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume SL0010’s inuseStatus is In use.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:finalizeVolume>
         <arg0>F50233</arg0>
      </ns1:finalizeVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
        <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:finalizeVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1219</return>
      </ns2:finalizeVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault   xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume SL0010’s onlineStatus is Offline</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Offline</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolume

该异步调用用于将卷格式化为 LTFS 格式的卷。该 LTFS-LE Web 服务不要求确认,也不对卷执行任何验证。您必须知道要格式化的卷并确保格式化正确的卷。

格式化卷时,会删除卷上以前的所有数据。

格式

formatVolume(String volser)

前提条件:

在格式化卷之前,验证卷是否已脱机且分配、在池中以及可用。检查是否有可用的兼容磁带机。

为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 确保卷处于前提条件要求的状态。

  • 如有必要,在继续之前执行更正操作。

要调用的 LTFS-LE Web 服务链:

formatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷现在为 LTFS-LE 格式。

参数

  • volser 是要弹出的卷的序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

以下列表显示了抛出的异常示例:

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010's onlineStatus is Online

  • The volume EL0010's assignedStatus is Unassigned.

  • The volume EL0010's availableStatus is Unavailable

建议的超时

7,200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:formatVolume>
         <arg0>F50234</arg0>
      </ns1:formatVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolumeWithDrive

该异步调用用于将卷格式化为 LTFS 格式,并在必须格式化特定磁带机上的卷时使用。卷和磁带机必须兼容。

格式

formatVolumeWithDrive (String volser, String drivesn)

前提条件:

在格式化卷之前,确认卷已脱机且分配、在池中以及可用。卷和磁带机必须存在于磁带库中,并且卷和磁带机必须兼容。磁带机必须处于空闲或可用状态。

为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • 确保卷处于前提条件要求的状态。

  • 如有必要,在继续之前执行更正操作。

要调用的 LTFS-LE Web 服务链:

formatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷现在为 LTFS-LE 格式。

参数

  • volser 是卷序列号。

  • drivesn 是格式化卷的磁带机的磁带机序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

以下列表显示了抛出的异常示例:

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010's assignedStatus is Unassigned.

  • The volume EL0010’s onlineStatus is Online.

  • The volume EL0010’s availableStatus is Unavailable

  • The drive 123456 is not found in LTFS library.

  • The drive 123456's availableStatus is In use

  • The drive 123456's onlineStatus is Offline

  • The drive 123456's assignedStatus is Unassigned

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:formatVolumeWithDrive>
         <arg0>F50234</arg0>
         <arg1>576001000421</arg1>
      </ns1:formatVolumeWithDrive>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The Volume F50377's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The Volume F50377's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

getVolumePath

该异步调用用于查找全局名称空间中的卷路径。

格式

getVolumePath(volser)

参数

  • volser 是要查找的卷路径的卷序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

卷必须存在于磁带库中,并且卷必须已分配且可用。

以下列表显示了抛出的异常示例:

  • The volume EL0020's assignedStatus is Unassigned.

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010’s availableStatus is Unavailable.

建议的超时

3600 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:getVolumePath>
         <arg0>F50233</arg0>
      </ns1:getVolumePath>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope  xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2: getVolumePath xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1225</return>
      </ns2: getVolumePath >
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope  xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

offlineVolume

该异步调用用于将卷置于脱机状态,从而对一个或多个卷进行弹出、vault 操作、格式化、分配和取消分配。

格式

offlineVolume(String[] volser)

前提条件:

在将卷设置为脱机之前,确认卷存在于磁带库中且状态为联机、已分配且可用以及最终化。检查是否有可用的兼容磁带机。

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 如果卷处于联机分配状态,则最终化卷。

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete >
    getJobResult(jobId)
    

要调用的 LTFS-LE Web 服务链:

offlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷现在已脱机。

参数

  • volser 是要使其脱机的卷的卷序列号。输入参数是一个字符串数组;该调用允许使多个卷脱机。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在将卷设置为脱机之前卷不满足以下条件:存在于磁带库中并且状态为联机、已分配、可用以及最终化,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Offline.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:offlineVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
      </ns1:offlineVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope    xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:offlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1218</return>
      </ns2:offlineVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

onlineVolume

该异步调用用于将卷置于联机状态(从而允许对卷进行读取、写入或最终化)。

格式

onlineVolume(String[] volsers)

前提条件:

在将卷设置为联机之前,确认卷存在于磁带库中且状态为脱机、已分配、在池中以及可用。检查是否有可用的兼容磁带机。

getVolumeInfoByVolser([volser1, volser2, ...])

要调用的 LTFS-LE Web 服务:

onlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷现在已联机。

参数

  • volser 是要使其联机的卷的卷序列号。输入参数是一个字符串数组;该调用允许使多个卷联机。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在将卷设置为联机之前卷不存在于磁带库中并且状态为联机、未分配、不在池中以及不可用,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:onlineVolume>
         <arg0>F40244</arg0>
         <arg0>F43022</arg0>
      </ns1:onlineVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:onlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1217</return>
      </ns2:onlineVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope    xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault    xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume SL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

prepareVolume

该异步调用用于将卷文件夹从 /LTFSLE/LOST+FOUND+VOLUMES/ 移动到 /LTFSLE/ 文件夹。

格式

prepareVolume(volser)

前提条件:

在准备卷之前,确认卷文件夹位于 /LTFSLE/LOST+FOUND+VOLUMES 中以及卷存在于磁带库中且状态为脱机、已分配以及可用。为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 获取卷的位置。

    getVolumePath(volser)
    
  • 在继续执行之前,确保卷处于所有所需的状态并执行更正操作(如有必要)。

要调用的 LTFS-LE Web 服务:

prepareVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则现在可以从 /LTFSLE 文件夹访问卷文件夹。

参数

  • volser 是要准备使其可通过 /LTFSLE/ 位置访问的卷序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在准备卷之前卷不存在于磁带库中并且状态为联机、未分配以及不可用,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

建议的超时

3600 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:prepareVolume>
         <arg0>F50233</arg0>
      </ns1:prepareVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope   xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:prepareVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:prepareVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope  xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unassignVolume

该命令用于取消将卷分配给 LTFS-LE。

格式

unassignVolume(String[] volsers)

前提条件:

取消分配卷之前,确认卷一定存在于磁带库中以及卷一定处于脱机、已分配、在池中以及可用状态。为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 在继续执行之前,确保卷处于所有所需的状态并执行更正操作(如有必要)。

要调用的 LTFS-LE Web 服务:

unassignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则会从 LTFS-LE 中取消分配卷。

参数

  • volser 是要取消分配的卷的卷序列号。输入参数是一个字符串数组,从而可以取消分配多个卷。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在取消分配卷之前卷不存在于磁带库中并且状态为联机、未分配、不在池中以及不可用,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:unassignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:unassignVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unassignVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:unassignVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolume

该异步 unformatVolume 调用用于从卷中删除 LTFS 格式。撤消 LTFS 卷格式时,将从卷中删除 LTFS 格式标头(元数据和数据分区),该卷将变为一个标准的非 LTFS 卷。

该 LTFS-LE Web 服务不要求确认,也不对卷执行任何验证。不过,撤消卷格式时,会删除卷上以前的所有数据。您必须知道要撤消格式的卷并确保对正确的卷撤消格式。

前提条件:

在撤消卷格式之前,确认卷处于脱机和未分配状态。检查是否有可用的兼容磁带机。

为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • 确保卷处于前提条件要求的状态。

  • 如有必要,在继续之前执行更正操作。

要调用的 LTFS-LE Web 服务链:

unformatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷不再为 LTFS-LE 格式,已从卷中删除 LTFS-LE 格式。

格式

unformatVolume(String volser)

参数

  • volser 是要撤消格式的卷的序列号。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在撤消卷格式之前卷不存在于磁带库中并且状态为联机、未分配以及不可用,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:unformatVolume>
         <arg0>F50344</arg0>
      </ns1:unformatVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp     xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault  xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolumeWithDrive

该异步调用用于从卷中删除 LTFS 格式。撤消 LTFS 卷格式时,将从卷中删除 LTFS 格式标头(元数据和数据分区),该卷将变为一个标准的非 LTFS 卷。

格式

unformatVolumeWithDrive (String volser, String drivesn)

前提条件:

卷和磁带机必须存在于磁带库中。卷和磁带机必须兼容。卷必须处于未分配、脱机和可用状态。磁带机必须处于空闲、联机或可用状态。

为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • 确保卷处于前提条件要求的状态。

  • 如有必要,在继续之前执行更正操作。

要调用的 LTFS-LE Web 服务链:

unformatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则卷现在为 LTFS-LE 格式。

参数

  • volser 是要撤消格式的卷序列号。

  • drivesn 是磁带机序列号,该序列号是由字符和数字构成的字符串。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果卷不存在于磁带库中并且状态为脱机、未分配、正在使用中以及不可用,或者磁带机与卷不兼容或不位于磁带库中,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

  • The volume's type LTO-5 is not compatible with drive's type T1C.

  • The drive HP23112 is not found in LTFS library.

  • The drive 123456's availableStatus is In use.

  • The drive 123456's onlineStatus is Offline.

  • The drive 123456's assignedStatus is Unassigned.

建议的超时

7200 秒

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:unformatVolumeWithDrive>
         <arg0>F50344</arg0>
         <arg1>576001000421</arg1>
      </ns1:unformatVolumeWithDrive>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp       xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume's type LTO-5 is not compatible with drive's type T1C</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume's type LTO-5 is not compatible with drive's type T1C</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

vaultVolume

此 API 函数对存在于 LTFS-LE 默认卷池中的一个或多个 LTFS-LE 卷执行 vault 操作。一次只能对一个卷执行 vault 操作。

该异步调用用于使用 CAP(中转槽)对最多 30 个卷执行 vault 操作。中转槽中可容纳四个卷。如果用户对 30 个卷执行 vault 操作,则每次将四个卷发送至中转槽,直到完成所有弹出。

格式

vaultVolume(String[] volsers,String acs,String lsm,String cap)

前提条件:

在执行 vault 操作之前,确认有可用的 CAP 以及卷处于最终化和脱机状态。卷的总数应为不超过 30 个。卷必须位于配置的同一个磁带库中。为此,将执行以下操作:

  • 获取卷状态:

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • 如果卷处于联机分配状态,则最终化卷:

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  • 如果卷联机,则在执行 vaultVolume API 调用之前使卷脱机:

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

要调用的 LTFS-LE Web 服务链:

vaultVolume([volser1,volser2,...],acs,lsm,cap)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

后期条件:

执行完这一系列 Web 服务调用之后,将生成一个 XML 文档。必须将其转换为相应的返回码。如果 API 调用成功,则会将卷加入磁带库。用户必须在打开 CAP 门之后走向磁带库并检索卷。

参数

  • volser 是要对其执行 vault 操作的卷的序列号。

  • acs 是磁带库 ACS 标识符。

  • lsm 是磁带库 LSM 标识符。

  • cap 是用于弹出卷的磁带库 CAP(中转槽)ID。

  • jobId 是用于检索作业状态和结果的作业 ID。

响应

SOAP 响应示例中显示了有效的响应。请参阅“词汇表”了解相关定义。

角色

管理员或服务人员

抛出的异常

ValidationFailedException

可能会抛出异常:

  • 如果未输入 volser 序列号,则抛出的异常为:"The parameter volsers is null"。

  • 如果在对卷执行 vault 操作之前卷不存在于磁带库中并且状态为联机、未分配、不在池中以及不可用,则可用状态会抛出验证失败异常:"volume [volume sn] status is []"。

例如:

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

建议的超时

这取决于管理员从 CAP(中转槽)中移除卷所花费的时间。

建议的作业轮询间隔

10 秒

SOAP 请求

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:vaultVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:vaultVolume>
   </env:Body>
</env:Envelope>

SOAP 响应

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:vaultVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1214</return>
      </ns2:vaultVolumeResponse>
   </S:Body>
</S:Envelope>

SOAP 故障

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault   xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>