List the Existing Cloud Staging Areas | RESTful API | Teradata Data Mover - List Cloud Staging Areas (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

List all the existing cloud staging areas using the following URL and method:
Item Description
URL /datamover/cloud-staging-areas/
Method GET

Request Parameters

No request parameters required.

Response Parameters

cloud_staging_areas
Description: Contains all current cloud staging areas
JSON Data Type: JSON Array (CloudStagingArea)
Required: Yes
messages
Description: Contains error and warning messages
JSON Data Type: Object (Messages)

Response Example

{
    "cloud_staging_areas": [
        {
            "name": "cs2-cloudstagingarea1",
            "storage_type": "s3",
            "source_target_pairs": [
                {
                    "source_system": "sourceSystem1",
                    "target_system": "targetSystem1"
                },
                {
                    "source_system": "sourceSystem2",
                    "target_system": "targetSystem2"
                }
            ]
        },
        {
            "name": "cs2-cloudstagingarea2",
            "storage_type": "s3",
            "source_target_pairs": [
                {
                    "source_system": "sourceSystem3",
                    "target_system": "targetSystem3"
                }
            ]
        }
    ],
    "messages": {
        "errors": [],
        "warnings": []
    }
}