Data Forestの概要
- 印刷する
- PDF
Data Forestの概要
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
NAVERクラウドプラットフォームは、NAVERの最新コンピューティング技術や運用ノウハウが蓄積されたクラウドサービスです。
NAVERクラウドプラットフォームが提供するサービスとソリューションを活用できるようにサポートするアプリケーションインターフェース(API)を、NAVERクラウドプラットフォームAPIといいます。
共通の設定
API URL
https://df.apigw.ntruss.com/api/v2/
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | - 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
| x-ncp-iam-access-key | NAVERクラウドプラットフォームで発行されたAPIキーまたはIAMで発行されたAccessKey |
| x-ncp-apigw-signature-v2 | - 上記例のボディをAccessKeyとマッピングするSecretKeyで暗号化した署名 - HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
オペレーション
Accounts
| API名 | 説明 |
|---|---|
| checkAvailableName | Data Forestアカウント作成時に作成可能なアカウント名かどうか確認 |
| checkHasResource | Data Forestアカウントを削除する前に、アカウント所有で作成されたリソースがないか確認 |
| create | Data Forestアカウントを作成 |
| getList | Data Forestのすべてのアカウントリストを照会 |
| getDetail | Data Forestアカウントの詳細情報を照会 |
| getKerberosKeytab | Data ForestアカウントのKerberos Keytabをダウンロード |
| resetKerberosKeytab | Data ForestアカウントのKerberos Keytabを初期化 |
| resetPassword | Data Forestアカウントのパスワードを初期化 |
| setQuota | Data ForestアカウントのHDFS Quotaを変更 |
| delete | Data Forestアカウントを削除 |
Notebooks
| API名 | 説明 |
|---|---|
| getVpclist | Notebook作成時、作成可能な VPCを確認します |
| getVpcDetail | Notebook作成時、VPCの詳細情報を確認します |
| getSubnetList | Notebook作成時、作成可能な Subnetを確認します |
| getSubnetDetail | Notebook作成時、Subnetの詳細情報を確認します |
| getTypeList | Notebook作成時、作成可能なNotebookクタイプを確認します |
| getServerTypeList | Notebook作成時に作成可能なサーバタイプを確認します |
| getList | 作成した Notebookのリストを照会します |
| getDetail | 作成した Notebookの詳細情報を確認します |
| getUserConfigurationSpecList | Notebookの構成に必要なユーザ設定を確認します |
| checkAvailableName | Notebookを作成する際に、作成可能な名前を確認します |
| getLoginKeyList | LoginKeyリストを確認します |
| restart | 作成した Notebookを再起動します |
| delete | Notebookを削除します |
| create | Notebookを作成します |
| setUserConfigurationList | ユーザーが構成した Notebook Specを設定します |
Apps
| API名 | 説明 |
|---|---|
| checkAvailableName | Data Forestアプリ作成時に作成可能なアプリ名かどうか確認 |
| getAppTypeIdList | Data ForestアプリタイプのIDリストを照会 |
| getAppBasicSetting | Data Forest指定のアプリタイプの基本作成設定を照会 |
| getAppTypeTemplate | Data Forest指定のアプリタイプのテンプレート情報を照会 |
| create | Data Forestアプリを作成 |
| getList | Data Forestアカウントのすべてのアプリリストを照会 |
| getDetail | Data Forestアプリの詳細情報を照会 |
| killContainer | Data Forestアプリのコンポーネントのコンテナを再起動 |
| killMaster | Data ForestアプリのアプリケーションMasterを再起動 |
| setContainerCount | Data Forestアプリのコンポーネントのコンテナ数を変更 |
| setLifetime | Data ForestアプリのLifetimeを変更 |
| start | Data Forestアプリを起動 |
| stop | Data Forestアプリを停止 |
| delete | Data Forestアプリを削除 |
AI Workspaces
| API名 | 説明 |
|---|---|
| checkAvailableName | AIワークスペースの名前として作成できるかどうか確認 |
| getDockerImageList | AIワークスペースのDockerイメージリストを照会 |
| create | AIワークスペースを作成 |
| getList | AIワークスペースのすべてのリストを照会 |
| getDetail | AIワークスペースの詳細情報を照会 |
| getConfigurationList | AIワークスペースの設定を照会 |
| setConfiguration | AIワークスペース設定を変更 |
| delete | AIワークスペースを削除 |
AI Apps
| API名 | 説明 |
|---|---|
| submit | AIアプリを実行 |
| getList | AIアプリのすべてのリストを照会 |
| getDetail | AIアプリの詳細情報を照会 |
| kill | AIアプリを停止 |
エラーコード
APIリクエストに誤りがあるか、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を、JSON/XML形式で詳細メッセージを返します。
レスポンス例
出力形式がJSONの場合
{
"error": {
"message": "リターンメッセージ",
"success": "false"
}
}
出力形式がXMLの場合
<ErrorResponse>
<message>リターンメッセージ</message>
<success>false</success>
</ErrorResponse>
エラーレスポンス
| HTTP Code | リターンメッセージ | 説明 | 解決策 |
|---|---|---|---|
| 400 | exceeded limit on resource quota | 作成上限超過 | サポート > お問い合わせに問い合わせる |
| 403 | not allowed to access | 権限がないリクエスト | 当該アカウントに権限を追加するか、適切な認証情報を使用 |
| 404 | no such element | 存在しないresourceまたは経路を照会 | 入力値を確認 |
| 500 | unexpected error | 不明なエラー発生 | サポート > お問い合わせに問い合わせる |
この記事は役に立ちましたか?