クラウド ステージング領域の編集(RESTful API) - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
17.20
Published
2022年9月
Language
日本語
Last Update
2022-10-12
dita:mapPath
ja-JP/tsn1650877444606.ditamap
dita:ditavalPath
ja-JP/mpm1591127278842.ditaval
dita:id
B035-4101
Product Category
Analytical Ecosystem

概要

このAPIにより、既存のクラウド ステージング領域を編集できます。既存のクラウド ステージング領域でAPIを使用して編集できる内容は以下に限られます。
  • アクセス キーID(クラウド ステージング領域の作成時に最初から指定された場合のみ)。
  • シークレット アクセス キー(クラウド ステージング領域の作成時に最初から指定された場合のみ)。
  • ソース ターゲットのペア。
以下のクラウド ステージング領域のプロパティは編集できません。
  • クラウド ステージング領域名
  • Buckets by Region(リージョン別バケット)

クラウド ステージング領域の名前またはリージョン別バケットのプロパティを変更するには、クラウド ステージング領域を削除し、目的の変更を加えて再度作成する必要があります。

以下のURLとメソッドを使用して、既存のクラウド ステージング領域を編集します。
アイテム 説明
URL /datamover/cloud-staging-areas/staging_area_name
メソッド PUT

リクエストのパラメータ

name
説明: クラウド ステージング領域の名前
JSONデータ型: 文字列
必須: はい
storage_type
説明: クラウド ストレージの種類を指定します。現時点ではS3のみがサポートされています
JSONデータ型: 文字列
必須: はい
s3_properties
説明: クラウド ステージング領域の作成に使用するAWS S3の情報
JSONデータ型: オブジェクト(S3Properties)
必須: いいえ
source_target_pairs
説明: ソースおよびターゲット システムの情報
JSONデータ型: JSON配列(SourceTargetPair)
必須: はい

応答のパラメータ

account_name
説明: 作成されたクラウド ステージング領域の名前
JSONデータ型: 文字列
messages
説明: エラー メッセージや警告メッセージの表示
JSONデータ型: オブジェクト(メッセージ)

応答の例

{
    "messages": {
        "errors": [],
        "warnings": []
    },
    "account_name": "my_staging_area"
}
以下に、あらかじめ定義済みのターゲット グループとターゲット グループ マッピングによって最初に作成されたクラウド ステージング領域を編集するための、リクエストの例を示します。このシナリオでは、source_target_pairsのみを編集できます。
{
    "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"
        }
    ]
}
以下に、AWS S3、ターゲット グループ、およびターゲット グループ マッピング用にData MoverによってDSCが構成されている場合の、クラウド ステージング領域を編集するためのリクエストの例を示します。このシナリオでは、access_key_idsecret_access_keysource_target_pairsを編集できます。
{
    "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"
        }
    ]
}