Flow Service APIを使用したデータフローの削除

エラーを含む、または Flow Service APIを使用して古くなったバッチおよびストリーミングデータフローを削除できます

このチュートリアルでは、を使用してバッチソースとストリーミングソースの両方で作成したデータフローを削除する手順について説明 Flow Serviceします。

はじめに

このチュートリアルでは、有効なフローIDが必要です。 有効なフローIDがない場合は、 ソースの概要から選択したコネクタを選択し 、このチュートリアルを試行する前に概要を説明した手順に従ってください。

また、このチュートリアルでは、Adobe Experience Platformの次のコンポーネントについて、十分に理解している必要があります。

  • ソース: Experience Platform 様々なソースからデータを取り込むことができ、 Platform サービスを使用してデータの構造化、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス: Experience Platform は、1つの Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

The following sections provide additional information that you will need to know in order to successfully delete a dataflow using the Flow Service API.

API 呼び出し例の読み取り

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

All resources in Experience Platform, including those belonging to Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

データフローの削除

既存のフローIDを使用して、 Flow Service APIに対するDELETE要求を実行することで、データフローを削除できます。

API 形式

DELETE /flows/{FLOW_ID}
パラメーター 説明
{FLOW_ID} 削除するデータフローの固有 id 値。

リクエスト

curl -X DELETE \
    'https://platform-int.adobe.io/data/foundation/flowservice/flows/20c115bc-46e3-40f3-bfe9-fb25abe4ba76' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、空白の本文とともに HTTP ステータス 204(コンテンツなし)を返します。データフローに対してルックアップ(GET)リクエストを試行すると、削除を確認できます。 APIは、データフローが削除されたことを示すHTTP 404 (見つかりません)エラーを返します。

次の手順

このチュートリアルに従うと、 Flow Service APIを使用して既存のデータフローを削除できます。

ユーザー・インタフェースを使用してこれらの操作を実行する手順については、UIでのデータ・フローの 削除に関するチュートリアルを参照してください

このページ