Data Transfer Essentials リソースを管理する

このページでは、Data Transfer Essentials を使用して作成されたリソースを管理する方法について説明します。

設定を管理する

プロジェクト内の Data Transfer Essentials 構成を一覧表示したり、構成の状態を確認したり、構成を更新したり、構成を削除したりできます。

プロジェクト内の構成を一覧表示する

プロジェクト内のロケーションにあるすべての構成を一覧表示するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs list コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs list \
    --location=LOCATION

LOCATION は、構成のリージョンに置き換えます。

API

multicloudDataTransferConfigs.get メソッドを使用します。

GET https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs

次のように置き換えます。

  • PROJECT_ID: オブジェクトの ID
  • LOCATION: 構成のリージョン

必要に応じて、requestID クエリ パラメータを使用して API リクエストを識別します。リクエストを再試行すると、サーバーはこの識別子を使用して、すでにレスポンスが返されたリクエストを無視できます。

構成の詳細を表示する

構成の詳細を表示するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs describe コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs describe CONFIGURATION_NAME \
    --location=LOCATION

次のように置き換えます。

  • CONFIGURATION_NAME: 構成の名前
  • LOCATION: 構成のリージョン

次のサンプル出力は、compute-engine からのトラフィックが Data Transfer Essentials の課金の対象となる準備ができていることを示しています。cloud-sql と cloud-storage の場合、更新は保留中です。effectiveTime 値は、状態が有効になる予定の時刻を示します。このサンプルには、構成内の宛先の合計数と、アクティブな宛先の数も示されています。

description: 'sample config'
destinationsCount: 2
destinationsActiveCount: 0
name: config1
region: https://www.googleapis.com/network-connectivity/v1/projects/my-project/locations/europe-west3
services:
- cloud-sql:
  states:
  - effectiveTime: 2024-12-12T08:00:00Z
    state: DELETING
- cloud-storage:
  states:
  - effectiveTime: 2024-12-12T08:00:00Z
    state: ADDING
- compute-engine:
  states:
  - state: ACTIVE
…

API

multicloudDataTransferConfigs.list メソッドを使用します。

GET https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME

次のように置き換えます。

  • PROJECT_ID: オブジェクトの ID
  • LOCATION: 構成のリージョン
  • CONFIGURATION_NAME: 構成の名前

次の出力例は、compute-engine からのトラフィックが Data Transfer Essentials の課金の対象となる準備ができていることを示しています。cloud-storage と cloud-sql の場合、更新は保留中です。effectiveTime 値は、状態が有効になる予定の時刻を示します。このサンプルには、構成内の宛先の合計数と、アクティブな宛先の数も示されています。

{
  "multicloudDataTransferConfig": [
    {
      "name": "projects/test-project/locations/europe-west1/multicloudDataTransferConfigs/config1",
      "createTime": "2025-05-14T10:16:22.761275571Z",
      "updateTime": "2025-05-14T10:16:25.872465362Z",
      "etag": "l-WY4OT6hBsMT8sAwEbuSpviLsE9iC_UDJXDyfE265I",
      "description": "sample config",
      "destinationsCount": 1,
      "destinationsActiveCount": 1,
      "services": {
        "cloud-sql": {
          "states": [
            {
              "effectiveTime": "2025-05-29T07:00:00Z",
              "state": "DELETING"
            }
          ]
        },
        "cloud-storage": {
          "states": [
            {
              "effectiveTime": "2025-05-29T07:00:00Z",
              "state": "ADDING"
            }
          ]
        },
        "compute-engine": {
          "states": [
            {
              "state": "ACTIVE"
            }
          ]
        }
      }
    }
  ]
}

サービスの状態は次のいずれかになります。

  • ADDING: サービスが追加されています。
  • DELETING: サービスが削除されています。
  • ACTIVE: サービスは Data Transfer Essentials の課金用に構成されています。

構成を更新する

構成からサービスを追加または削除するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs update コマンドを使用します。

サービスを指定するには、次のいずれかのオプションを使用します。

  • services: 構成内のサービスを指定されたリストに置き換えます
  • update-services: 指定されたサービスを構成に追加します
  • remove-services: 指定されたサービスを構成から削除します
  • clear-services: 構成からすべてのサービスを削除します
gcloud network-connectivity multicloud-data-transfer-configs update CONFIGURATION_NAME \
    --location=LOCATION \
    --description=DESCRIPTION \
    --services=SERVICE-A,... |
        --update-services=SERVICE-A,... |
        --remove-services=SERVICE-A,... |
        --clear-services

次のように置き換えます。

  • CONFIGURATION_NAME: 更新する構成の名前。
  • LOCATION: 構成のリージョン。
  • DESCRIPTION: 構成とその目的の説明。
  • SERVICE-A,...: 構成に追加または削除するサービスを表す一連の文字列。有効な文字列については、サポートされているサービスとリージョンをご覧ください。clear-services を使用して、構成からすべてのサービスを削除します。

API

multicloudDataTransferConfigs.update メソッドを使用します。

PATCH https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME
{
  "description": "DESCRIPTION",
  "services": {
    "SERVICE-A",
    "SERVICE-B"
  }
}

次のように置き換えます。

  • PROJECT_ID: 実際のプロジェクトの ID。
  • LOCATION: 構成のリージョン。
  • CONFIGURATION_NAME: 構成の名前。
  • DESCRIPTION: 構成とその目的の説明。
  • SERVICE-A: 構成に追加または削除するサービスを表す一連の文字列。有効な文字列については、サポートされているサービスとリージョンをご覧ください。

また、更新オペレーション中に指定したフィールドのセットが上書きされないようにするには、fieldMask 形式に従う updateMask オプションを使用します。

Data Transfer Essentials の構成に対する更新は、約 24 時間後に有効になります。

構成を削除する

構成を削除するには、関連付けられているすべての宛先を削除する必要があります。

構成を削除するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs delete コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs delete CONFIGURATION_NAME \
    --location=LOCATION

API

multicloudDataTransferConfigs.delete メソッドを使用します。

DELETE https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME

リンク先を管理する

プロジェクト内の Data Transfer Essentials の宛先を一覧表示したり、宛先の状態を確認したり、宛先を更新または削除したりできます。

プロジェクト内の宛先を一覧表示する

プロジェクト内のすべての宛先を一覧表示するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs destinations list コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs destinations list \
    --multicloud-data-transfer-config=CONFIGURATION_NAME \
    --location=LOCATION

次のように置き換えます。

  • CONFIGURATION_NAME: 宛先を一覧表示する構成の名前
  • LOCATION: 構成のリージョン

API

multicloudDataTransferConfigs.destinations.list メソッドを使用します。

GET https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME

次のように置き換えます。

  • PROJECT_ID: オブジェクトの ID
  • LOCATION: 構成のリージョン
  • CONFIGURATION_NAME: 宛先を一覧表示する構成の名前

リンク先の詳細を表示する

宛先の詳細を表示するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs destinations describe コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs destinations describe DESTINATION_NAME \
    --multicloud-data-transfer-config=CONFIGURATION_NAME \
    --location=LOCATION

次のように置き換えます。

  • DESTINATION_NAME: 宛先の名前
  • CONFIGURATION_NAME: 宛先を表示する構成の名前
  • LOCATION: 構成のリージョン

次のサンプルは、destination1 に指定されたエンドポイントが有効であり、effectiveTime で示された時刻までに宛先が追加されていることを示しています。

createTime: '2025-05-28T13:08:00.171978514Z'
description: 'sample destination'
endpoints:
- asn: 16509
  csp: aws
  state: VALID
etag: tag1
ipPrefix: 203.0.113.0/24
name: projects/test-project/locations/europe-west3/multicloudDataTransferConfig/config1/destinations/destination1
stateTimeline:
  states:
  - effectiveTime: '2025-05-29T07:00:00Z'
    state: ADDING
updateTime: '2025-05-28T13:08:03.431862259Z'
…

API

multicloudDataTransferConfigs.destinations.get メソッドを使用します。

GET https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME/destinations/DESTINATION_NAME

次のように置き換えます。

  • PROJECT_ID: オブジェクトの ID
  • LOCATION: 構成のリージョン
  • CONFIGURATION_NAME: 構成の名前
  • DESTINATION_NAME: 宛先の名前

次の出力例は、destination1 に指定されたエンドポイントが有効であり、effectiveTime で示された時刻までに宛先が追加されていることを示しています。

{
  "destination": [
    {
      "name": "projects/test-project/locations/europe-west3/multicloudDataTransferConfig/config1/destinations/destination1",
      "createTime": "2025-05-14T10:18:16.941520739Z",
      "updateTime": "2025-05-14T10:18:20.028116272Z",
      "etag": "tag1",
      "description": "sample destination",
      "ipPrefix": "203.0.113.0/24",
      "endpoints": [
        {
          "asn": 16509,
          "csp": "aws",
          "state": "VALID"
        }
      ],
      "stateTimeline": {
        "states": [
          {
            "state": "ADDING",
            "effectiveTime": "2025-05-29T07:00:00Z"
          }
        ]
      }
    }
  ]
}

宛先の場合、状態は次のいずれかになります。

  • ADDING: 宛先が追加されています。
  • DELETING: 宛先が削除されています。
  • SUSPENDING: 監査に基づいて宛先が一時停止されています。
  • ACTIVE: 宛先は Data Transfer Essentials の課金の対象となります。
  • SUSPENDED: 宛先が削除されたか、利用規約に違反しているため、Data Transfer Essentials の課金対象になりません。

エンドポイントの状態は次のいずれかになります。

  • VALID: ASN と CSP の値の組み合わせが有効です。
  • INVALID: ASN 値と CSP 値の組み合わせが無効です。

1 つのエンドポイントの状態が VALID の場合、宛先は Data Transfer Essentials の課金対象と見なされます。

すべてのエンドポイントの状態が INVALID の場合、宛先は Data Transfer Essentials の課金対象外と見なされます。この場合、現在の状態が ADDING か ACTIVE かに応じて、宛先の状態は SUSPENDING または SUSPENDED に設定されます。このような宛先へのトラフィックは、通常のインターネット トラフィックとして扱われます。

掲載先を更新する

宛先には 1 つ以上のエンドポイントが必要で、5 つを超えるエンドポイントを指定することはできません。

宛先のエンドポイントを追加または削除するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs destinations update コマンドを使用します。

エンドポイントを指定するには、次のいずれかのオプションを使用します。同じコマンドで add-endpoints フラグまたは remove-endpoints フラグを複数回指定できます。

  • endpoints: 宛先のエンドポイントを指定されたリストに置き換えます
  • add-endpoints: 指定されたエンドポイントを宛先に追加します
  • remove-endpoints: 指定されたエンドポイントを宛先から削除します
gcloud network-connectivity multicloud-data-transfer-configs destinations update DESTINATION_NAME \
    --multicloud-data-transfer-config=CONFIGURATION_NAME \
    --location=LOCATION \
    --description=DESCRIPTION \
    --ip-prefix=IP_PREFIX \
    --endpoints=asn=ASN,csp=CSP |
        --add-endpoints=asn=ASN,csp=CSP |
        --remove-endpoints=asn=ASN,csp=CSP

次のように置き換えます。

  • DESTINATION_NAME: 宛先の名前。
  • CONFIGURATION_NAME: 更新する構成の名前。
  • LOCATION: 構成のリージョン。
  • DESCRIPTION: 宛先とその目的の説明。
  • IP_PREFIX: 範囲または値として指定された宛先の IP プレフィックス。

  • エンドポイントごとに、次の項目を指定します。

    • ASN: プレフィックスをアナウンスすることが想定される ASN。認識された ASN をご覧ください。
    • CSP: プレフィックスをアナウンスしている ASN の CSP を表す文字列。

API

multicloudDataTransferConfigs.destinations.update メソッドを使用します。

PATCH https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME/destinations/DESTINATION_NAME
{
  "description": "DESCRIPTION",
  "ip_prefix": "IP_PREFIX",
  "endpoints": [
    {
      "asn": "ASN",
      "csp": "CSP"
    }
  ]
}

次のように置き換えます。

  • PROJECT_ID: 実際のプロジェクトの ID。
  • LOCATION: 構成のリージョン。
  • CONFIGURATION_NAME: 構成の名前。
  • DESTINATION_NAME: 宛先の名前。
  • DESCRIPTION: 宛先とその目的の説明。

  • IP_PREFIX: 範囲（203.0.113.0/24 や 2001:db8::/32 など）または値（203.0.113.6 や 2001:db8:2:2:2:2:2:2 など）として指定された宛先の IP プレフィックス。IP プレフィックスは、構成内で 1 回だけ、1 つの ASN に対してのみ使用する必要があります。

  • 宛先に追加するエンドポイントに対応する文字列を指定するか、宛先に保持しないエンドポイントを削除します。

    • ASN: プレフィックスをアナウンスすることが想定される ASN。認識された ASN をご覧ください。
    • CSP: プレフィックスをアナウンスしている ASN の CSP を表す文字列。

また、更新オペレーション中に指定したフィールドのセットが上書きされないようにするには、fieldMask 形式に従う updateMask オプションを使用します。

Data Transfer Essentials の宛先と関連する構成の更新は、約 24 時間で有効になります。

宛先の削除

宛先を削除するには、次のいずれかの方法を使用します。

gcloud

gcloud network-connectivity multicloud-data-transfer-configs destinations delete コマンドを使用します。

gcloud network-connectivity multicloud-data-transfer-configs destinations delete DESTINATION_NAME \
    --multicloud-data-transfer-config=CONFIGURATION_NAME \
    --location=LOCATION

API

multicloudDataTransferConfigs.destinations.delete メソッドを使用します。

DELETE https://networkconnectivity.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/multicloudDataTransferConfigs/CONFIGURATION_NAME/destinations/DESTINATION_NAME