Create Cloud Staging Area | RESTful API | Teradata Data Mover - Create Cloud Staging Area (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide - 20.01

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Mover
Release Number
20.01
Published
November 2023
Language
English (United States)
Last Update
2023-12-05
dita:mapPath
hlv1700545853003.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
don1467241476387
Product Category
Analytical Ecosystem

Overview

Following are the two options for creating a Cloud Staging Area:
  • Provide Source and Target system Target Groups that have already been defined in DSC and paired in a Target Group Map.
  • Provide AWS S3 information and allow Data Mover to define the Target Groups and Map.
Create a Cloud Staging Area using the following URL and method:
Item Description
URL /datamover/cloud-staging-areas
Method POST

Request Parameters

name
Description: Name of the cloud staging area
JSON Data Type: String
Required: Yes
storage_type
Description: Specify cloud storage type. Currently only S3 is supported
JSON Data Type: String
Required: Yes
s3_properties
Description: AWS S3 information used to create the cloud staging area
JSON Data Type: Object (S3Properties)
Required: No
source_target_pairs
Description: Source and target system information
JSON Data Type: JSON Array (SourceTargetPair)
Required: Yes

Response Parameters

account_name
Description: Name of the created cloud staging area
JSON Data Type: String
messages
Description: Contains error and warning messages
JSON Data Type: Object (Messages)

Response Example

{
    "messages": {
        "errors": [],
        "warnings": []
    },
    "account_name": "my_staging_area"
}
The following is a request example to create cloud staging area by providing predefined Target Groups:
{
    "name": "cs2-cloudstagingarea",
    "storage_type": "S3",
    "source_target_pairs": [
        {
            "source_system": "sourceSystem",
            "source_system_target_group": "sourceTGroup",
            "target_system": "targetSystem",
            "target_system_target_group": "targetTGroup"
        },
        {
            "source_system": "targetSystem2",
            "source_system_target_group": "targetTGroup2",
            "target_system": "sourceSystem2",
            "target_system_target_group": "sourceTGroup2"
        }
    ]
}
The following is a request example to create cloud staging area by providing AWS information where Data Mover creates Target Groups:
{
    "name": "cs2-cloudstagingarea",
    "storage_type": "S3",
    "s3_properties": {
        "access_key_id": "ABCDEFGH",
        "secret_access_key": "AbcDEfgHIjklmNop123/456qRstUVwXyZ",
        "buckets_by_region": [
            {
                "buckets": [
                    {
                        "bucket_name": "example-bucket",
                        "prefix_list": [
                            {
                                "prefix_name": "backup",
                                "storage_devices": 100
                            }
                        ]
                    }
                ],
                "region": "us-west-2"
            }
        ]
    },
    "source_target_pairs": [
        {
            "source_system": "sourceSystem",
            "target_system": "targetSystem"
        },
        {
            "source_system": "sourceSystem2",
            "target_system": "targetSystem2"
        }
    ]
}