アプリケーションを管理¶

レジストリのアプリケーションページには、すべてのアプリケーションタブで使用可能なすべてのアプリケーションが一覧表示されます。次の表は、このページの要素と使用可能なアクションを示します。

	要素	説明
1	アプリケーション名	アプリケーション名。
2	バージョン	アプリケーションまたはソースのバージョン番号を一覧表示します。
3	開く	クリックすると、アプリケーションまたはソースが開きます。
4	アクションメニュー	アクションメニューから、以下の操作が可能です。共有：アプリケーションをユーザー、グループ、組織と共有できるほか、DataRobot以外のユーザーとも共有リンクを通じて共有できます。名前の変更：アプリケーションの名前を編集できます。ソースに移動：アプリケーションに関連付けられたソースを開きます。ソースの置換：アプリケーションに別のソースを選択できます。サービスの正常性：メモリー、CPU、およびネットワークの使用状況を表示するダッシュボードを開きます。ユースケースへのリンク：アプリケーションからユースケースへのリンクを確立し、ユースケースアセットにアプリケーションを表示します。ログを表示：アプリケーションのコンパイル、構築、および実行の履歴を表示します。アクセスログを表示：どのユーザーがいつアプリケーションにアクセスしたかを表示します。停止：アプリケーションを停止します。削除：アプリケーションを削除します。
5	検索	リスト内の特定のアプリケーションを検索するために使用します。
6	「アプリケーション」タブ	構築されたアプリケーションまたはアプリケーションソースの表示を選択します。
7	ドロップダウンを追加	追加ドロップダウンを使用して、アプリケーションをアップロードするか、または新しいアプリケーションソースを作成します。

共有機能は権限を管理し、ユーザー、グループ、組織、およびDataRobot以外の受信者とアプリケーションを共有できます。この機能は、アプリケーションを作成するための専門知識のないユーザーに既存のアプリケーションの使用を許可する場合などに便利です。

注意

複数のユーザーが同じアプリケーションにアクセスできる場合、各ユーザーは、別のユーザーが行った変更や予測を表示、編集、上書きしたり、アップロードしたデータセットを見たりすることができます。この動作は、アプリケーションの性質によって異なります。

すべてのアプリケーションタブで共有機能にアクセスするには、共有したいアプリの横にあるアクションメニュー をクリックし、共有を選択します。

これにより共有ウィンドウが開き、ユーザーとその役割がリストされます。エディターは、1つ以上のユーザーまたはグループ、組織全体でアプリケーションを共有できます。さらに、共有リンクを使ってアプリケーションを外部と共有できます。

ユーザー、グループ、組織外部共有

次と共有フィールドにユーザー名、グループ、または組織を入力します。
権限の設定には、ドロップダウンからロールを選択します。
通知を送信を選択してEメール通知を送信し、メモを追加を選択して通知に詳細を追加します。
共有をクリックします。グループまたは組織と共有している場合、アプリの共有先およびロールの適用先は、指定されたグループまたは組織のすべてのメンバーです。

外部共有では、リンク経由でDataRobotにアクセスできないエンドユーザーとアプリケーションを共有できます。 DataRobot以外のユーザーとアプリケーションを共有するには：

外部共有リンクタブをクリックします。タブ名の横にあるアイコンは、外部共有が現在有効かどうかを示します。
外部共有を有効にするをオンに切り替えます。追加のフィールドが以下に表示されます。
アプリケーションにアクセスできるようにしたいすべてのメールドメインとアドレスを追加します。メールアドレスとドメインは正しい形式（例：@datarobot.com）で入力する必要があります。また、ここにリストされているユーザーのみが共有リンク経由でアプリにアクセスできます。
アプリケーションリンクをコピーをクリックし、このリンクを前の手順で指定したすべてのユーザーに送信します。該当のユーザーにはDataRobotから招待メールが届きます。確認にはこのリンクが必要になります。招待メールは、ユーザーに送信されてから1時間後に有効期限が切れます。ユーザーが認証を受け入れると、作成された認証トークンは30日後に失効します。

アプリケーションのアクセス権を取り消す

外部共有を有効にするをオフに切り替えることで、いつでも共有リンクへのすべてのアクセス権を取り消すことができます。また、許可されたフィールドからメールドメインとアドレスを削除することで、個々のアクセス権を取り消すこともできます。

セルフマネージド環境での外部共有

セルフマネージド環境でアプリケーションを外部ユーザーと共有するには、簡易メール転送プロトコル（SMTP）サーバーを設定する必要があります。

DRApps CLIを使用して、アプリケーションをプログラムで共有することもできます。

共有ダイアログでは、次のアクションも使用できます。

ユーザーを削除するには、削除するユーザーの役割の右側にある「X」ボタンをクリックします。
ユーザーの役割を再度割り当てるには、割り当てられた役割をクリックして、ドロップダウンから新しい役割を割り当てます。

アプリケーションのAPIキー¶

アプリケーションの共有に加えて、アプリケーション内からデータにアクセスして使用する機能をユーザーに付与することもできます。アプリケーションのAPIキーは、DataRobotのパブリックAPIに対して必要なアクセス権をアプリケーションに付与します。共有ロールは、DataRobot内のエンティティとしてアプリケーションの制御を許可し、アプリケーションのAPIキーは、ユーザーがアクセスしたときにアプリが実行できるリクエストの制御を許可します。

アプリケーションソースの必要なキースコープレベル設定は、アプリケーションが使用できる2つのAPIキーに対して、スコープレベルがどのように適用されるかを制御します。同じドロップダウン値を選択しても、クリエイターAPIキーとビジターAPIキーにはそれぞれ異なるスコープレベルが設定されます。

キーレベル設定	クリエイターAPIキーレベル	ビジターAPIキーレベル
なし	N/A	管理
閲覧者	閲覧者	閲覧者
ユーザー	ユーザー	ユーザー
管理	管理	管理

N/Aは、キーレベル設定においてクリエイターAPIキーにHTTPメソッドのスコープが割り当てられないことを意味します。クリエイターキーは、DATAROBOT_API_TOKENを通じて引き続き使用できます。
キーレベル設定がなしの場合、x-datarobot-api-keyリクエストヘッダーにビジターAPIキーは挿入されません。各リクエストでビジターキーを転送するには、キーレベルを閲覧者、ユーザー、または管理者に設定します。

クリエイターAPIキーとビジターAPIキー¶

1つのアプリケーションで2つの異なるAPIキーを使用できます。

キー	アプリによるアクセス方法	可用性
クリエイターAPIキー	`DATAROBOT_API_TOKEN`環境変数	常に起動時にアプリケーションコンテナに挿入されます。アプリケーションのバックエンドは、このキーを使用して、アプリ作成者に代わってREST APIを呼び出します。このキーがエンドユーザーに公開されることはありません。
ビジターAPIキー	`x-datarobot-api-key`リクエストヘッダー	アクセスしたユーザー自身のDataRobot APIキーで、リクエストヘッダー内でプロキシによって転送されます。アプリケーションは、このキーを使用して、現在アプリを操作しているユーザーに代わってREST APIを呼び出すことができます。キーレベルの設定が「閲覧者」、「ユーザー」、または「管理者」の場合にのみ挿入されます。挿入されると、ビジターキーは上記の表に示されているスコープレベルを使用します。なお、ビジターAPIキーはデフォルトでは提供されません。キーレベル設定が指定されている場合にのみ提供されます。

クリエイターAPIキーは、アプリケーションを初めて起動した際に自動的に作成されます。このキーは、停止および再起動のサイクルを超えて保持され、アプリケーション自体が削除された場合にのみ削除されます。このキーには有効期限がありません（UI上の有効期限列が空になっていることからもわかります）。

アプリ作成者は、APIのキーとツールページのCustomApp <application-id>の下で、このキーを確認できます。そこから、作成者はキーをコピーし、DataRobot Public APIを呼び出す必要がある他のユーザーと共有できます。個人のDataRobot APIキーは必要ありません。アプリケーションのAPIキーは許可されているAPIエンドポイントにスコープが設定されているため、作成者の個人キーが持つすべての権限ではなく、定義されたアクセス権のサブセットのみを付与します。

新しいアプリを構築する場合と、既存のアプリのソースを更新する場合

クリエイターAPIキーは、特定のソースバージョンではなく、アプリケーションを構築した、または最後に更新したユーザーに紐付けられています。既存のアプリケーションのソースを（ソースの置換または新しいソースバージョンのデプロイを通じて）、当初構築したのと同じユーザーで更新した場合、既存のキーは保持されます。別のユーザーがソースを更新した場合、キーはそのユーザーのキーに変更されます。ただし、ソースから新しいアプリケーションを構築する場合（以前にアプリの構築で使用されたものと同じソースであっても）、DataRobotは新しいキーでアプリケーションエンティティを新たに作成します。

HTTPメソッドのスコープ¶

「閲覧者」、「ユーザー」、または「管理者」のスコープレベルがAPIキーに適用される場合、そのキーは、そのレベルで許可されているHTTPメソッドを使用して許可されているAPIエンドポイントのみを呼び出すことができます。

スコープレベル	エンドポイントで許可されているメソッド
閲覧者	`GET`のみ
ユーザー	`GET`, `POST`, `PATCH`, and `PUT`
管理	すべてのHTTPメソッド（`DELETE`を含む）

許可されているAPIエンドポイント¶

アプリケーションのAPIキーでは、パブリックAPI全体へのアクセス権は付与されません。各キーでは、カスタムアプリケーションで許可されているエンドポイントのみを呼び出すことができます。お使いの環境で利用可能なエンドポイントについては、許可されているエンドポイントのリストをご確認ください。

システム管理者だけが、カスタムアプリケーションにおいて許可または禁止するエンドポイントをシステム設定で変更できます。誰がそのロールを保持するかは、デプロイによって異なります。

デプロイ	許可されたエンドポイントの管理者
マルチテナントSaaS（MTS）	DataRobotサポート
シングルテナントSaaS（STS）とオンプレミス	組織のシステム管理者

スコープレベルの設定¶

アプリケーションソースで必要なキースコープレベルを設定するには、以下の手順に従ってください。

アプリケーションのソースに移動し、新しいバージョンを作成します。
リソースセクションで、編集をクリックします。
リソースを更新モーダルから、必要なキースコープレベルドロップダウンを使用してキーレベルの設定を選択します。各オプションの効果については、キーレベル対応表およびHTTPメソッドのスコープを参照してください。
更新をクリックします。設定したソースからアプリケーションを構築すると、選択したスコープレベルがアプリケーションのAPIキーに適用されます。

アプリケーションコードでAPIキーを使用する¶

アプリケーションのコードでは、クリエイターAPIキーを使用できます。また、スコープレベルが「閲覧者」以上の場合、ビジターAPIキーも使用できます。以下の例では、StreamlitとFastAPIでそれぞれを使用する方法を示します。

# Work with creator API key

endpoint = os.environ.get("DATAROBOT_ENDPOINT")
owner_api_key = os.environ.get("DATAROBOT_API_TOKEN")  # creator's Application API key (scoped)

with datarobot.Client(token=owner_api_key, endpoint=endpoint) as client:
    deployments = datarobot.Deployment.list()  # get list of app creator's datasets


# Work with visitor API key
## Streamlit

endpoint = os.environ.get("DATAROBOT_ENDPOINT")
headers = streamlit.context.headers  # request headers
visitor_api_key = headers.get('x-datarobot-api-key')  # visitor's API key from request headers

with datarobot.Client(token=visitor_api_key, endpoint=endpoint) as client:
    datasets = datarobot.Dataset.list()  # get list of visitor's datasets


## FastAPI

_router = fastapi.APIRouter(tags=["Datasets"])

@_router.get("/datasets")
async def chat_completion(request: fastapi.Request) -> Any:
    endpoint = os.environ.get("DATAROBOT_ENDPOINT")
    visitor_api_key = request.headers.get('x-datarobot-api-key')  # visitor API key from request headers

    with datarobot.Client(token=visitor_api_key, endpoint=endpoint) as client:
        datasets = datarobot.Dataset.list()  # get list of visitor datasets

ユースケースへのリンク¶

アプリケーションをワークベンチのユースケースにリンクするには、アプリケーションのアクションメニューで、 ユースケースへのリンクをクリックします。

ユースケースへのリンクモーダルで、次のいずれかのオプションを選択します。

ユースケースの選択ユースケースの作成リンクされたユースケースの管理

オプション	説明
ユースケースの選択	ユースケース名ドロップダウンリストをクリックして既存のユースケースを選択してから、ユースケースへのリンクをクリックします。
ユースケースの作成	新しいユースケース名とオプションの説明を入力し、ユースケースの作成をクリックして、ワークベンチで新しいユースケースを作成します。
リンクされたユースケースの管理	ユースケースの横にあるマイナスアイコンをクリックしてアセットとのリンクを解除してから、選択されたリンクを解除をクリックします。

アプリケーションの削除¶

適切な権限がある場合、アクションメニュー をクリックし、削除（）をクリックすることで、アプリケーションを削除できます。