编辑云暂存区 (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
zh-CN/tsn1650877444606.ditamap
dita:ditavalPath
zh-CN/mpm1591127278842.ditaval
dita:id
B035-4101
Product Category
Analytical Ecosystem

概览

此 API 可以编辑现有的云暂存区。您可以使用 API 在现有云暂存区中编辑的内容存在以下限制:
  • 访问密钥 ID(仅当最初在创建云暂存区时提供的情况下)。
  • 访问密钥(仅当最初在创建云暂存区时提供的情况下)。
  • 源目标对。
您无法编辑的云暂存区的属性包括:
  • 云暂存区名称
  • 按区域组织的存储桶

要更改云暂存区的名称或按区域组织的存储桶属性,您必须删除云暂存区并使用所需的更改重新创建。

使用以下 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"
        }
    ]
}
以下是一个请求示例,用于编辑 Data Mover 为 AWS S3、目标组和目标组映射配置了 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"
        }
    ]
}