当您使用 HTTP与传输对象请求传输信息时,以下属性将在指定的JSON对象中返回。
destinationAgent
- 名称
- 字符串。
- 指定目标系统上的代理的名称。
- 将始终返回此属性。
- qmgrName
- 字符串。
- 指定目标系统上队列管理器的名称。
发起方
- 主机
- 字符串。
- 指定源文件所在系统的主机名。
- 将始终返回此属性。
- mqmdUserId
- 字符串。
- 指定在消息描述符 (MQMD) 中提供的 IBM® MQ 用户标识。
- userID
- 字符串。
- 指定发起文件传输的用户标识。
- 将始终返回此属性。
sourceAgent
- 名称
- 字符串。
- 指定源系统上代理程序的名称。
- 将始终返回此属性。
- qmgrName
- 字符串。
- 指定源系统上队列管理器的名称。
statistics
- endTime
- 字符串。
- 指定传输完成的时间。 仅当传输完成时,才会更新此字段。 如果传输处于任何其他状态,那么 endTime 是空字符串。
- 将始终返回此属性。
- numberOfFileFailures
- 整数。
- 指定未能成功传输的文件数。
- 将始终返回此属性。
- numberOfFileSuccesses
- 整数。
- 指定成功传输的文件数。
- 将始终返回此属性。
- numberOfFileWarnings
- 整数。
- 指定生成警告但以其他方式成功传输的文件数。
- 将始终返回此属性。
- numberOfFiles
- 整数。
- 指定传输请求中包含的文件总数。 此数字包括为传输操作考虑的所有文件。
- 将始终返回此属性。
- retryCount
- 整数。
- 指定传输进入恢复状态并由代理重试的次数。
- 传输可能会进入恢复状态,因为源代理和目标代理由于 IBM MQ 网络错误而失去通信,或者由于代理在一段时间内未接收数据或应答消息。 此时间段由代理程序属性 transferAckTimeout 和 transferAckTimeoutRetries确定。
- startTime
- 字符串。
- 指定以 UTC 格式提交传输的时间。
- 将始终返回此属性。
状态
- 描述
- 字符串。
- 指定有关完成时状态的详细信息,例如是部分成功,成功还是失败。
- lastStatusUpdate
- 字符串。
- 以 UTC 格式指定最近一次捕获传输状态的时间。
- state
- 字符串。
- 指定传输的状态。 该值可以是下列任一值:
- 已启动
- inProgress
- 成功
- 失败
- partiallySuccessful
- 已取消
- 格式不正确
- notAuthorized
- deleted
- inProgressWithFailures
- inProgressWithWarnings
- 将始终返回此属性。
transferSet
- bytesSent
- 整数。
- 指定发送的总字节数。
- 项
- JSON 对象。
- 包含用于指定源和目标文件名及位置的元素:
- destination
- JSON 对象。
- actionIfExists
- 字符串。
- 指定在目标系统上已存在目标文件时执行的操作。 有效选项如下:
- 错误
- 报告错误并且不传输文件。
- overwrite
- 覆盖现有目标文件。
- 校验和
- JSON 对象。
- 如果未执行校验和,那么不会显示此对象。
- 指定生成消息摘要以创建数字签名的散列算法的类型。 Managed File Transfer 仅支持消息摘要算法 5 (md5)。 校验和提供一种方法来确认传输文件的完整性。
- JSON 对象包含以下元素:
- 方法 (method)
- 字符串。
- 指定用于生成校验和的方法。
- 值
- 字符串。
- 指定生成的校验和值。
- 数据集
- JSON 对象。
- 如果返回了
file 或 queue 对象,那么不会返回此对象。
- 指定具有以下元素的 z/OS® 数据集:
- 属性
- 字符串。
- 指定与数据集相关的属性。
- 名称
- 字符串。
- 指定数据集的名称。
- size
- 整数。
- 指定文件大小。
- 文件
- JSON 对象。
- 如果返回了
queue 或 dataset 对象,那么不会返回此对象。
- 指定有关在以下元素中传输的文件的信息:
- 编码
- 字符串。
- 指定文本文件传输的编码。
- endOfLine
- 指定行结束标记符。 此值可以是下列其中一个值:
- 仅 LF-换行符。
- CRLF-回车符和换行符序列。
- lastModified
- 字符串。
- 以 UTC 格式指定文件的上次修改日期和时间。
- path
- 字符串。
- 指定文件的路径位置。
- size
- 整数。
- 指定文件大小。
- 队列
- JSON 对象。
- 如果返回了
file 或 dataset 对象,那么不会返回此对象。
- 在以下元素中指定有关将消息传输到的队列的信息:
- delimiter
- 字符串。
- 指定使用的定界符。
- 如果 delimiterType 设置为 size,那么此元素指定定界符大小。 如果 delimiterType 设置为 binary,那么值为定界符字节数。
- 如果 delimiter 是空字符串,那么在启动传输时不会设置该字段。
- delimiterPosition
- 字符串。
- 仅当 delimiterType 为 binary时,此元素才有效。 该值是下列其中一个值:
- "前缀"
- 在每条消息之前。
- "后缀"
- 在每条消息之后。
- 如果 delimiterPosition 是空字符串,那么在启动传输时不会设置该字段。
- delimiterType
- 字符串。
- 指定用于拆分消息的定界符类型。 该值可以是下列任一值:
- 二进制
- 按定界符字节分割。
- size
- 按大小拆分。
- 如果 delimiterType 是空字符串,那么在启动传输时不会设置该字段。
- includeDelimiterInMessage
- 布尔值。
- 仅当 delimiterType 为 binary时,此元素才有效。
- 指定是否在消息中包含定界符。
- messageCount
- 整数。
- 指定写入队列的消息数。
- messageLength
- 整数。
- 指定写入队列的消息的长度。
- messageOrGroupId
- 字符串。
- 如果传输请求未指定将文件拆分为多条消息,那么此属性的值是写入队列的消息的 IBM MQ 消息标识。
- 如果传输请求指定将文件拆分为多条消息,那么此属性的值是写入队列的消息的 IBM MQ 组标识。
- 名称
- 字符串。
- 指定队列和队列管理器的名称,格式如下:
queueName@queueManagerName
- 类型
- 字符串。
- 指定目标的类型。 目标是下列其中一个目标:
- 队列
- 指定 IBM MQ 队列作为目标。
- 文件
- 指定文件作为目标。
- 数据集
- 指定 z/OS 数据集作为目标。
- mode
- 字符串。
- 指定传输方式为二进制还是文本。
- 源
- JSON 对象。
- 校验和
- JSON 对象。
- 如果未执行校验和,那么不会显示此对象。
- 指定生成消息摘要以创建数字签名的散列算法的类型。 Managed File Transfer 仅支持消息摘要算法 5 (md5)。 校验和提供一种方法来确认传输文件的完整性。
- JSON 对象包含以下元素:
- 方法 (method)
- 字符串。
- 指定用于生成校验和的方法。
- 值
- 字符串。
- 指定生成的校验和值。
- disposition
- 字符串。
- 指定成功将源传输到其目标时对源元素执行的操作。 此字符串是下列其中一个选项:
- leave
- 指定源文件保持不变
- delete
- 指定在成功传输源文件后从源系统中删除源文件
- 数据集
- JSON 对象。
- 如果返回了
file 或 queue 对象,那么不会返回此对象。
- 指定具有以下元素的 z/OS 数据集:
- 属性
- 字符串。
- 指定与数据集相关的属性。
- 名称
- 字符串。
- 指定数据集的名称。
- size
- 整数。
- 指定文件大小。
- 文件
- JSON 对象。
- 如果返回了
queue 或 dataset 对象,那么不会返回此对象。
- 此对象包含以下元素:
- 编码
- 字符串。
- 指定文本文件传输的编码。
- endOfLine
- 指定行结束标记符。 此值可以是下列其中一个值:
- 仅 LF-换行符。
- CRLF-回车符和换行符序列。
- lastModified
- 字符串。
- 以 UTC 格式指定文件的上次修改日期和时间。
- path
- 字符串。
- 指定文件的路径位置。
- size
- 整数。
- 指定文件的大小。
- 队列
- JSON 对象。
- 如果返回了
file 或 dataset 对象,那么不会返回此对象。
- 在以下元素中指定有关从中检索传输消息的队列的信息:
- messageCount
- 整数。
- 指定从队列读取的消息数。
- 名称
- 字符串。
- 指定队列和队列管理器的名称,格式如下:
queueName@queueManagerName
- setMqProperties
- 布尔值。
- 指定是否在文件中的第一条消息上设置 IBM MQ 消息属性,以及发生错误时写入队列的任何消息。
- 类型
- 字符串。
- 指定源的类型。 源是下列其中一个源:
- 队列
- 指定 IBM MQ 队列作为源。
- 文件
- 如果源是文件或目录,那么指定文件作为源。
- 数据集
- 指定 z/OS 数据集作为源。
- 状态
- JSON 对象。
- 指定传输集中单个项的状态。 状态对象包含以下元素:
- 描述
- 字符串。
- 指定有关状态完成的详细信息,例如是部分成功,成功还是失败。
- state
- 字符串。
- 指定传输的状态。 该值可以是下列任一值:
- 已启动
- inProgress
- 成功
- 失败
- partiallySuccessful
- 已取消
- 格式不正确
- notAuthorized
- deleted
- inProgressWithFailures
- inProgressWithWarnings