Create a Target - Teradata Listener

Teradata® Listener™ User Guide

Product
Teradata Listener
Release Number
2.03
Published
September 2018
Language
English (United States)
Last Update
2018-10-01
dita:mapPath
kum1525897006440.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-2910
lifecycle
previous
Product Category
Analytical Ecosystem
The following is a list of items needed in order to create a new target:
  • A JSON object with properties for the new target, read-only properties are ignored
  • The target must be associated with a source, system, and associated connection details
  • The user must also be an owner of the associated source

Definition

POST https://listener-app-services.teradata.com/v1/targets HTTP/1.1

Example Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X POST \
  -d '{
    "source_id": "84757abc-ba43-5736-0ba3-1bdac4748290",
    "system_id": "9dda5570-70e0-45be-8449-83f33320cd08",
    "name": "My Data Target",
    "description": "A superb data target",
    "target_type": "teradata",
    "data_path": {
      "schema": "schema",
      "table": "table"
    },
    "system_info": {
      "username": "ip112233",
      "password": "password"
    },
    "production": false,
    "bundle": true,
    "bundle_type": "records",
    "bundle_interval": 500
  }' \
  -i \
  https://listener-app-services.teradata.com/v1/targets

HDFS with Kerberos Example Request

{
  "bundle": false,
  "bundle_interval": 0,
  "data_path": {
    "extension": "seq",
    "path": "/user/testuser"
  },
  "dead_letter_queue": "",
  "name": "TestTargetKerberizedHDFS",
  "description": "Test Target Kerberized HDFS",
  "source_id": "{{source_id}}",
  "state": "1",
  "system_id": "{{system_id}}",
  "system_info": {},
  "target_type": "hdfs",
  "properties": {
    "base64KeytabContent": "BQIAAABd...",
    "kdc": "ip-172-29-29-21.us-west-2.compute.internal:88",
    "principal": "testuser@CDH.US-WEST-2.COMPUTE.INTERNAL"
  }
}

Example Response

HTTP/1.1 201 OK
Content-Type: application/json
{
  "target_id": "758fbda4-accc-4f90-8f09-cc0a164c8c28",
  "source_id": "84757abc-ba43-5736-0ba3-1bdac4748290",
  "system_id": "9dda5570-70e0-45be-8449-83f33320cd08",
  "owner": ["jd123456"],
  "created_at": "2015-07-04T10:20:00Z",
  "created_by": "av012345",
  "updated_at": "2015-12-20T10:20:00Z",
  "updated_by": "jd123456",
  "name": "My Data Target",
  "description": "A superb data target",
  "target_type": "teradata",
  "data_path": {
    "schema": "schema",
    "table": "table"
  },
  "system_info": {
    "username": "ip112233",
    "password": "password"
  },
  "state": 1,
  "production": false,
  "bundle": true,
  "bundle_type": "records",
  "bundle_interval": 500
}

Response Codes

Code Description
201 Target successfully created.
400 Required property missing from request.
401 Authorization header not found.