Dataphin:サービスプロジェクトの作成と管理

前提条件

サービスプロジェクトを作成する前に、ゲートウェイを構成する必要があります。詳細については、「DataService Studio の設定」をご参照ください。

権限

• スーパー管理者とシステム管理者は、サービスプロジェクトとそのメンバーを作成および管理できます。

• プロジェクト管理者は、割り当てられたプロジェクトとメンバーを管理できます。

サービスプロジェクトの作成

1. Dataphin のホームページの上部のメニューバーで、[サービス] > [サービス管理] を選択します。

2. 左側のナビゲーションウィンドウで、[プロジェクト管理] をクリックします。[プロジェクト管理] ページで、右上の [+サービスプロジェクトの作成] ボタンをクリックします。

3. [サービスプロジェクトの設定] ダイアログボックスで、パラメーターを構成します。

   パラメーター	説明
   サービスプロジェクト名	サービスプロジェクトの名前を入力します。 名前は次の要件を満たしている必要があります。 漢字、英字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。 中国語の文字または英字で始まる必要があります。 長さは 32 文字を超えることはできません。
   説明	サービスプロジェクトの簡単な説明を入力します。 説明は 128 文字を超えることはできません。
   API リリース制御	API が公開されると、5 種類の変更が API とそれに関連付けられた複合 API への通常の呼び出しに影響を与える可能性があります。これらの変更は、必須リクエストパラメーターの追加、リクエストパラメーターの削除、レスポンスパラメーターの削除、リクエストパラメーターのデータの型の変更、および呼び出しタイプの変更です。したがって、API がアプリケーションに付与されたり、複合 API によって参照されたりした後、API の新しいバージョンは公開される前にオンラインバージョンと比較されます。上記の変更のいずれかが存在する場合、プロジェクトと API の使用シナリオに基づいて API のリリース コントロール メカニズムを構成できます。次の 2 つのシナリオで公開をブロックするか許可するかを選択できます。 API がアプリケーションに承認されている: デフォルトは [公開をブロック] で、[公開を許可] に変更できます。 API が複合 API によって参照されている: デフォルトは [公開をブロック] で、[公開を許可] に変更できます。 次の一覧は、さまざまなリリース コントロール メカニズムの適用範囲を説明しています。 [API はアプリケーションに承認されています] と [API は複合 API によって参照されています] が [公開をブロック] に設定されている場合、API がアプリケーションにアタッチされているか、複合 API によって参照されていると、新しいバージョンは公開できません。これにより、ダウンストリームのアプリケーションと複合 API が正常に呼び出されることが保証されます。この設定は、使用範囲が広く影響が大きい重要な API に適しており、変更を公開するとダウンストリームシステムに深刻な影響を与える場合に適しています。 [API はアプリケーションに承認されています] が [公開を許可] に設定され、[API は複合 API によって参照されています] が [公開をブロック] に設定されている場合、API が複合 API によって参照されていると、新しいバージョンは公開できません。これにより、複合 API が正常に呼び出されることが保証されます。開発者は、影響を受けるアプリケーションのオーナーにオフラインで通知する必要があります。この設定は、API の変更が公開された後、アプリケーションのオーナーに迅速に通知してアプリケーションの呼び出し構成を調整できるシナリオに適しています。これにより、アプリケーションが API を正常に呼び出せるようになります。 説明 API が他の複合 API によって参照されており、それらのオーナーに時間内に修正を通知できない場合、API の変更の公開は許可されません。これにより、子 API の変更によって複合 API が失敗するのを防ぎます。 [API はアプリケーションに承認されています] が [公開をブロック] に設定され、[API は複合 API によって参照されています] が [公開を許可] に設定されている場合、API がアプリケーションにアタッチされていると、新しいバージョンは公開できません。これにより、ダウンストリームのアプリケーションが正常に呼び出されることが保証されます。開発者は、影響を受ける複合 API のオーナーにオフラインで通知する必要があります。この設定は、ダウンストリームのアプリケーションが API を正常に呼び出せることだけを保証する必要があるシナリオに適しています。 説明 API が他の複合 API によって参照されている場合、開発者はそれらの複合 API のオーナーに時間内に修正を通知する必要があります。これにより、複合 API が正常に呼び出せるようになります。 [API はアプリケーションに承認されています] と [API は複合 API によって参照されています] が [公開を許可] に設定されている場合、新しいバージョンを公開できます。開発者は、影響を受ける複合 API とダウンストリームのアプリケーションのオーナーに通知する必要があります。この設定は、影響が小さく、ダウンストリームのユーザーが少ない API に適しており、変更を公開しても API が失敗してもビジネスに影響がない場合に適しています。 リリース制御基準の定義が変更されました。 4.4 より前のバージョンのユーザーは、次の図を参照して対応する基準を表示できます。

4. [送信] をクリックしてサービスプロジェクトを作成します。

サービスプロジェクトの管理

[プロジェクト管理] ページでは、プロジェクトメンバーの追加、サービスプロジェクトグループの作成、サービスプロジェクトの編集または削除ができます。