16.20 - Data Mover RESTful API 调用 - Teradata Data Mover

Teradata® Data Mover 用户指南

Product
Teradata Data Mover
Release Number
16.20
Published
2021 年 11 月
Content Type
用户指南
Publication ID
B035-4101-107K-CHS
Language
中文 (简体)
对 Data Mover RESTful API 服务的调用涉及以下元素:
  • HTTPS 缺省处于启用状态。
  • 对 Data Mover RESTful 接口的所有调用将返回一个用于指示调用成功与否的 HTTPS 状态代码。

    有关详细信息,请参阅 RESTful API 状态代码

  • 对 Data Mover RESTful 接口的某些调用会在响应正文中以 JSON 格式返回信息。
  • 用于标识运行 REST 服务的 Data Mover 服务器的 URL,例如 https://dmprod:1443/datamover/jobs.dmprod,其中路径的每个部分用于定义以下内容:
    • dmprod–Data Mover 服务器的 DNS 别名
    • 1443– REST 服务侦听的缺省端口
    • /datamover/jobs – 所引用的 REST 资源
  • 对 Data Mover RESTful API 的每次调用都是使用特定 HTTPS 方法实现的:GET、POST、PUT 或 DELETE。在相同的 REST 资源上使用不同的 HTTPS 方法可执行不同的操作。如以下示例所示:
    • /datamover/jobs 上使用 GET 将返回所有 Data Mover 作业的列表
    • /datamover/jobs 上使用 POST 将创建一个新作业

    对 Data Mover RESTful 接口的任何调用必须包含一个“接受标头”,其中会使用 API 版本。提供的标头是一个键值对。键为 Accept,当前版本值为 application/vnd.com.teradata.datamover-v1.0+json

  • 对 Data Mover RESTful API 的某些调用可能需要一个输入参数。输入参数要么在请求正文中以 json 格式指定, 要么在 url 路径本身中提供。

    URL 路径的示例:https://dmprod:1443/datamover/jobs/job-name?outputLevel=4,其中 outputLevel=4 是一个参数。