GET

使用 HTTP与 transfer 资源请求有关传输和传输状态的信息。您只能查询在 mqweb 服务器启动后启动的传输。

注：

必须先设置协调队列管理器，然后才能使用 transfer 资源。有关更多信息，请参阅为 MFT 配置 REST API。
mqweb 服务器高速缓存有关传输的信息，并在发出请求时返回此信息。重新启动 mqweb 服务器时，将重置此高速缓存。您可以通过查看 console.log 和 messages.log 文件或在 z/OS®上查看启动式任务的输出来查看服务器是否已重新启动。
此资源在独立 IBM® MQ Web Server 安装中不可用。有关运行 administrative REST API的 IBM MQ 组件的安装选项的更多信息，请参阅 IBM MQ Console 和 REST API。

有关配置 MFT REST 服务的更多信息，请参阅为 MFT 配置 REST API。

资源 URL
可选的查询参数
请求头
请求主体格式
安全要求
响应状态码
响应头
响应主体格式
示例

资源 URL

https://host:port/ibmmq/rest/v2/admin/mft/transfer/{transferID}

transferID: (可选) 指定要查询的传输的标识。; 如果未指定传输标识，那么将返回传输列表。

如果启用 HTTP 连接，您可以使用 HTTP 代替 HTTPS。如需了解启用 HTTP 的更多信息，请访问配置 HTTP 和 HTTPS 端口。

可选的查询参数

属性: 指定要检索的属性的逗号分隔列表。; 仅当指定了传输标识时，此查询参数才有效。; 如果未指定 attributes，那么将返回缺省属性集。请参阅传输的响应主体属性以获取可用属性的列表。; 不能多次请求同一属性。; 您可以指定星号 * 以指定返回所有属性。; 您可以发出指定对某些传输无效的属性的请求。但是，如果您发出指定传输标识的请求，并且包含对该传输无效的属性，那么将发生错误。
限制: 指定要检索的最大传输数。; 仅当未指定传输标识时，此查询参数才有效。; 例如，如果 limit=200，那么 REST API 将返回最多 200 个传输。
晚于: 指定传输标识。将检索在指定传输之后启动的所有传输。如果指定 after，那么不能同时指定 before。; 仅当未指定传输标识时，此查询参数才有效。
早于: 指定传输标识。将检索在该特定传输之前启动的所有传输。如果指定 before，那么不能同时指定 after。; 仅当未指定传输标识时，此查询参数才有效。

请求头

必须随请求一起发送以下头:

授权: 如果使用基本认证，那么必须发送此头。有关更多信息，请参阅将 HTTP 基本认证用于 REST API。

请求主体格式

无。

安全类的要求

调用者必须向 mqweb 服务器进行认证，并且必须属于 MFTWebAdmin、MFTWebAdminRO 或 MQWebUser 角色中的一个或多个角色。有关 administrative REST API 的安全性的更多信息，请参阅 IBM MQ Console 和 REST API 安全性。

必须向调用者的安全主体授予预订 SYSTEM.FTE/Transfer 主题的权限。

如果使用基于令牌的安全性，那么用于认证用户的 LTPA 令牌必须作为 cookie 随请求一起提供。有关基于令牌的认证的更多信息，请参阅将基于令牌的认证用于 REST API。

响应状态码

200

已成功检索传输信息。

400

提供的数据无效。

例如，指定的属性无效。

401

未认证。

必须向 mqweb 服务器认证调用者。有关更多信息，请参阅安全性需求。

403

由于下列其中一个原因而禁止访问:

未授权。调用者已向 mqweb 服务器进行认证，并且与有效主体相关联。但是，主体不是一个或多个 MFTWebAdmin， MFTWebAdminRO或 MQWebUser 角色的成员。有关所需访问权的更多信息，请参阅安全性需求。
在当前服务器环境中禁止访问。 administrative REST API 在独立 IBM MQ Web Server 安装中不可用。

404

具有指定标识的传输不存在。

500

来自 IBM MQ的服务器问题或错误代码。

503

队列管理器未运行。

响应头

内容类型: 此标头返回时带有值 application/json;charset=utf-8。
ibm-mq-rest-mft-total-传输: 返回此头的值为 mqweb 服务器高速缓存中具有可用详细信息的传输总数。

响应主体格式

响应采用 JSON 格式，采用 UTF-8 编码。响应包含外部 JSON 对象，该对象包含名为 transfer的单个 JSON 数组。数组中的每个元素都是一个 JSON 对象，用于表示有关传输的信息。其中每个 JSON 对象都可以包含以下对象和属性。返回的对象和属性取决于请求中指定URL ：

标识: 字符串。; 指定唯一的传输或事务标识。该标识最多可包含 48 个字母数字字符。; 将始终返回此属性。
作业: JSON 对象。; 包含传输的作业名。
userProperties: JSON 对象。; 包含有关传输的其他元数据。 "userProperties":{"key1":"value1"}例如：
sourceAgent: JSON 对象。; 包含与源系统上的代理程序相关的属性。; 将始终返回此对象中的 name 属性。
destinationAgent: JSON 对象。; 包含与目标系统上的代理程序相关的属性。; 将始终返回此对象中的 name 属性。
发起方: JSON 对象。; 包含与请求发起方相关的属性。; 将始终返回此对象中的 host 和 host 属性。
transferSet: JSON 对象。; 包含与文件传输组相关的属性。
状态: JSON 对象。; 包含与传输状态相关的属性。; 将始终返回此对象中的 state 属性。
statistics: JSON 对象。; 包含与传输统计信息相关的属性。; 将始终返回此对象中的 startTime， numberOfFileFailures ， numberOfFileSuccesses， numberOfFileWarnings， numberOfFiles 和 endTime 属性。

有关更多信息，请参阅传输的响应主体属性。

如果发生错误，请参阅 REST API 错误处理。

示例

以下示例返回响应中的缺省数据集。

URL 使用 HTTP 方法：

https://localhost:9443/ibmmq/ibmmq/rest/v2/admin/mft/transfer/414d512050524d465444454d4f312020f5189c5921f22302

将返回以下 JSON 响应:

{                
   "transfer": [{                                
      "id": "414D512050524D465444454D4F312020F5189C5921F22302",
      "destinationAgent": {
          "name": "AGENT.TRI.BANK"
      },
      "originator": {
         "host": "192.168.99.1",
         "userId": "johndoe"
      },
      "sourceAgent": {
         "name": "TESTAGENT"
      },
      "statistics": {
         "endTime": "2018-01-08T16:22:15.569Z",
         "numberOfFileFailures": 0,
         "numberOfFileSuccesses": 2,
         "numberOfFileWarnings": 0,
         "numberOfFiles": 2,
         "startTime": "2018-01-08T16:22:15.242Z"
      },
      "status": {
         "state": "successful"
      }
   }]
}

以下示例列出了协调队列管理器上指定传输标识的所有属性。 URL 使用 HTTP 方法：

https://localhost:9443//ibmmq/rest/v2/admin/mft/transfer/414d512050524d465444454d4f312020c5c6705924cf9e02?attributes=*

将返回以下 JSON 响应:

{                
   "transfer": [{                                
      "id": "414D512050524D465444454D4F312020C5C6705924CF9E02",	               
      "sourceAgent": {			
         "qmgrName": "PRMFTDEMO1",
         "name": "AGENT2"	
      },
      "destinationAgent": {
         "qmgrName": "PRMFTDEMO1",
         "name": "AGENT1"                                              
      },
      "originator": {
         "host": "192.168.56.1",
         "userId": "johndoe",
         "mqmdUserId": "johndoe"
      },
      "transferSet": {
         "item": [{
            "source": {
               "file": {
                  "lastModified": "2017-07-13T11:25:20.780Z",
                  "size":179367055 ,
                  "path": "D:/ProgramFiles/WASlibertyprofile.zip"
               },
               "checksum": {
                  "method": "md5",
                  "value": "5F0ED36FBD3C0E1F4083B12B34A318D3"
               },
               "disposition": "leave",
               "type": "file"
            },
            "destination": {
               "file": {
                  "lastModified": "2017-07-28T08:00:12.065Z",
                  "size": 179367055,
                  "path": "C:/Users/IBMADMIN/Desktop/demo.zip"
               },
               "checksum": {
                  "method": "md5",
                  "value": "5F0ED36FBD3C0E1F4083B12B34A318D3"
               },
               "actionIfExists": "overwrite",
               "type": "file"
            }, 
            "status": { 
               "description": "BFGRP0032I: The file transfer request has successfully completed."           
               "state":"successful"
            }
            "mode": "binary"
         }],
         "bytesSent": 0,
         "startTime": "2017-07-28T08:00:10.599Z"
      },
      "job": {
         "name":"job1"
      },
      "userProperties":{
      },
      "status": {
         "lastStatusUpdate": "2017-07-28T08:00:10.599Z",
         "state":"successful",
         "description": "BFGRP0032I: The file transfer request has successfully completed."
      },
      "statistics": {
         "startTime": "2017-07-28T08:00:09.897Z",
         "retryCount": 0,
         "endTime": "2017-07-28T08:00:10.599Z",
         "numberOfFilesSuccesses":1,
         "numberOfFileFailures": 0,
         "numberOfFileWarnings": 0,
         "numberOfFiles":1
      }
   }]
}