DataWorks:API の管理

API の表示

1. DataWorks コンソールにログインします。 左側のナビゲーションウィンドウで、[DataService Studio] をクリックします。 表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[DataService Studioに移動] をクリックします。

2. サービス開発 ページで、Workflow > API ノードを展開します。

3. 対象の API を右クリックし、Details を選択します。

   説明

   Details オプションは、公開済みの API でのみ使用できます。API が公開されていない場合は、編集ページを開き、右側のペインで Property をクリックして基本情報を表示できます。

API のクローン

API をディレクトリツリー内の指定したパスにクローンできます。

1. サービス開発 ページで、Workflow > API ノードを展開します。

2. 対象の API を右クリックし、Cloningを選択します。

3. [API のクローン] ダイアログボックスで、次のパラメーターを設定します。

   パラメーター	説明
   [API Name]	名前は 4～50 文字で、漢字、英字、数字、アンダースコア (_) を使用できます。名前は漢字または英字で始める必要があります。
   [APIPath]	API が格納されるパス。例: /user。 API パスには、英字、数字、アンダースコア (_)、ハイフン (-) を使用できます。パスはスラッシュ (/) で始まり、長さは 200 文字を超えることはできません。
   [Description]	クローンされた API の説明。
   [Location]	API を格納するディレクトリ。

4. Confirm をクリックします。

API の削除

DataService Studio では、未公開の API のみ削除できます。公開済みの API を削除するには、まず API を非公開化する必要があります。

1. (任意) API を非公開化します。

   API が公開されていない場合は、この手順をスキップしてください。

   1. サービス開発 ページで、上部にある Service Management をクリックして Manage APIs ページに移動します。

      デフォルトでは、このページには [公開済み API] のリストが表示されます。各 API の [操作] 列には、[非公開化]、[権限付与]、[テスト]、[その他] などのボタンがあります。

   2. Published APIs タブで、対象の API を探し、[操作] 列にある オフライン をクリックします。

   3. API を公開停止した後、ページ上部の サービス開発 をクリックして サービス開発 ページに戻ります。

2. サービス開発 ページで、Workflow > API ノードを展開します。

3. 削除する API を右クリックし、[削除] を選択します。

   重要

   この操作は元に戻せません。操作は慎重に行ってください。

API の移動

DataService Studio では、未公開の API のみ移動できます。公開済みの API を移動するには、まず API を非公開化する必要があります。

1. (任意) API を非公開化します。

   API が公開されていない場合は、この手順をスキップしてください。

   1. サービス開発 ページで、上部にある Service Management をクリックして Manage APIs ページに移動します。

      デフォルトでは、このページには [公開済み API] のリストが表示されます。各 API の [操作] 列には、[非公開化]、[権限付与]、[テスト]、[その他] などのボタンがあります。

   2. Published APIs タブで、対象の API を探し、[操作] 列にある オフライン をクリックします。

   3. API を公開停止した後、ページ上部の サービス開発 をクリックして サービス開発 ページに戻ります。

2. サービス開発 ページで、Workflow > API ノードを展開します。

3. 移動する API を右クリックし、[移動] を選択します。

4. Move Node ダイアログボックスで、Location を選択し、Confirm をクリックします。

5. 重要

   API を移動するとグループが変更される可能性があり、公開後のエンドポイント URL に影響を与えることがあります。公開済みの API を移動する際は、慎重に操作してください。

一括操作

DataWorks では、API に対して一括操作を実行できます。たとえば、DataService Studio のリソースグループの変更、API の提出、公開などです。これにより、リソースグループを効率的に切り替え、API をオンラインにすることができます。

1. [サービス開発] ページで、左側のディレクトリツリーの上部にある アイコンをクリックして、一括操作ページに移動します。

2. 一括操作ページの上部で、Workflow や Owner などの条件で API を絞り込みます。

3. フィルタリングされたリストで、一括操作を実行する API のチェックボックスをオンにします。

4. API を選択した後、ページの下部から一括操作を選択します。

   次の表では、一括操作と API の状態との関係を説明します。

   一括操作	未公開かつ未提出	未公開かつ提出済み	公開済みかつ未提出	公開済みかつ提出済み
   サービスリソースグループの変更
   提出		すでに提出されている API は提出できません。API を再提出するには、その編集ページに移動し、右側のペインでVersion Management タブを開き、以前に提出したバージョンを破棄してください。		送信済みの API は送信できません。API を再送信するには、編集ページに移動し、右側のペインでVersion Managementタブを開き、送信済みのバージョンを破棄してください。
   公開	API は、公開する前に提出する必要があります。		API は、公開する前に提出する必要があります。

   説明

   公開済みの API のリソースグループを変更した後、変更を有効にするには、API を再度テスト、提出、公開する必要があります。

API コード検索

現在のワークスペース内でスクリプトモードで作成された API のコードを検索できます。

1. ナビゲーションペインで、 アイコンをクリックしてコード検索ページに移動します。

   [サービス開発] ページのナビゲーションペインには、コード、テーブル、検索などのいくつかの機能アイコンがあります。コード検索のメインペインには、[API] タブと [データプッシュ] タブがあります。検索バーでは、ID、名前、または API パスで検索できます。検索バーの下には、折りたたみ可能な [ビジネスプロセス] セクションがあります。

2. 検索ボックスの右側にある アイコンをクリックして、フィルターオプションを展開します。

   検索ボックスに API 名、API パス、API の説明、テーブル名、フィールド名などのキーワードを入力して API を検索できます。また、所有者、ビジネスプロセス、変更日時などの基準で検索結果をフィルタリングすることもできます。

3. 検索結果の表示

   検索条件に一致する結果が検索バーの下に表示され、次の情報が含まれます。

   説明

   検索結果には、公開済みの API のみが含まれます。

   • API 名： API 名をクリックすると、右側にその設定ペインが開きます。

   • コードコンテンツ： 一致したキーワード、その行番号、および簡単なコンテキストが表示されます。一致したコードをコピーできます。

   • 基本情報： API ID、所有者、ビジネスプロセス、最終変更日時が表示されます。