API 標準および多言語対応の SDK
本製品 (pai-dsw/2022-01-01) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
インスタンス
|
API |
タイトル |
説明 |
| GetInstanceEvents | GetInstanceEvents | DSW インスタンスのシステムイベントを取得します。 |
| UpdateInstanceLabels | UpdateInstanceLabels | Data Science Workshop (DSW) インスタンスのタグを更新します。タグが存在しない場合、システムはタグを追加します。 |
| DeleteInstanceLabels | DeleteInstanceLabels | Data Science Workshop (DSW) インスタンスからラベルを削除します。 |
ライフサイクル
|
API |
タイトル |
説明 |
| GetLifecycle | GetLifecycle | インスタンスのライフサイクルを取得します。 |
リソース監視
|
API |
タイトル |
説明 |
| GetInstanceMetrics | GetInstanceMetrics | インスタンスのリソースメトリックをクエリします。 |
インスタンススナップショット
|
API |
タイトル |
説明 |
| CreateInstanceSnapshot | CreateInstanceSnapshot | インスタンススナップショットを作成します。 |
| DeleteInstanceSnapshot | DeleteInstanceSnapshot | インスタンススナップショットを削除します。 |
| GetInstanceSnapshot | GetInstanceSnapshot | GetInstanceSnapshot 操作を呼び出して、インスタンス スナップショットを取得します。 |
| ListInstanceSnapshot | ListInstanceSnapshot | インスタンススナップショットをリスト表示します。 |
統計
|
API |
タイトル |
説明 |
| GetResourceGroupStatistics | GetResourceGroupStatistics | リソースグループは、Platform for AI (PAI) 向けに専用のマシンリソースを提供する機能です。これらのリソースは、ご利用の PAI コンピューティングタスクおよび Data Science Workshop (DSW) インスタンスの実行に使用されます。本操作では、指定されたリソースグループ内の DSW インスタンスについて、現在および過去のステータス（成功・失敗・停止したインスタンス数など）に関する統計情報を取得します。これらの統計情報により、タスク履歴の把握やリソース使用量の最適化が可能になります。 |
| ListInstanceStatistics | ListInstanceStatistics | インスタンスの統計情報を取得します。 |
スケジュールされた自動インスタンスシャットダウン
|
API |
タイトル |
説明 |
| CreateInstanceShutdownTimer | CreateInstanceShutdownTimer | インスタンスに対して、スケジュールされた停止タスクを作成します。 |
| DeleteInstanceShutdownTimer | DeleteInstanceShutdownTimer | インスタンスの定時停止タスクを削除します。 |
| GetInstanceShutdownTimer | GetInstanceShutdownTimer | インスタンスにスケジュールされたシャットダウンタスクの詳細を取得します。 |
アイドルインスタンス自動シャットダウン
|
API |
タイトル |
説明 |
| CreateIdleInstanceCuller | CreateIdleInstanceCuller | 特定の Data Science Workshop (DSW) インスタンスに対して自動停止ポリシーを作成します。条件が満たされると、インスタンスは自動的に停止されます。アイドル状態の DSW インスタンスに対しては、自動停止ポリシーを 1 つのみ作成できます。特定のインスタンスに自動停止ポリシーが設定されている場合、まず `DeleteIdleInstanceCuller` を呼び出して削除してください。 |
| DeleteIdleInstanceCuller | DeleteIdleInstanceCuller | インスタンスの自動停止ポリシーを削除します。 |
| GetIdleInstanceCuller | GetIdleInstanceCuller | 特定のアイドル状態のインスタンスに対する自動停止ポリシーの情報を照会します。 |
ECS インスタンスタイプ
|
API |
タイトル |
説明 |
| ListEcsSpecs | ListEcsSpecs | ECS インスタンスタイプのリストを取得します。 |
ユーザー構成
|
API |
タイトル |
説明 |
| GetUserConfig | GetUserConfig | GetUserConfig を呼び出して、ユーザー情報をクエリできます。 |
その他
|
API |
タイトル |
説明 |
| CreateDiagnosis | CreateDiagnosis | インスタンスの問題を診断します。 |
| GetMetrics | GetMetrics | インスタンスのメトリックを取得します。 |
| GetUserCommand | GetUserCommand | ユーザー定義コマンドを取得します。 |
| ListSystemLogs | ListSystemLogs | システムログを取得します。この API は非推奨であり、使用しないでください。 |
Others
|
API |
タイトル |
説明 |
| CreateInstance | CreateInstance | CreateInstance は DSW インスタンスを作成します。 |
| CreateSanityCheckTask | CreateSanityCheckTask | 指定された DSW インスタンスの非同期ヘルスチェックタスクを送信します。この操作を呼び出すには、`ssh` などのチェックタイプとインスタンス ID を指定する必要があります。システムは、タスクが正常にキューに追加されたことを示す一意のタスク ID (TaskId) をすぐに返します。この操作は非ブロッキングであり、チェック結果を待たないため、高速な応答が求められるシナリオに適しています。後でタスク ID を使用して、実行ステータスと詳細な結果をクエリできます。 |
| CreateTempFile | CreateTempFile | 一時ファイルを作成します。 |
| CreateTempFileTask | CreateTempFileTask | 一時ファイルタスクを作成します。 |
| DeleteInstance | DeleteInstance | 特定のインスタンスを削除します。 |
| DeleteInstances | DeleteInstances | 複数のインスタンスをバッチで削除します。 |
| DeleteTempFile | DeleteTempFile | 一時ファイルを削除します。 |
| DeleteTempFileTask | DeleteTempFileTask | 一時ファイルタスクを削除します。 |
| DeleteTempFileTasks | DeleteTempFileTasks | 一時ファイルタスクを 1 件以上削除します。 |
| GetInstance | GetInstance | DSW インスタンスの詳細を取得します。 |
| GetSanityCheckTask | GetSanityCheckTask | ヘルスチェックタスクのステータスおよび結果を照会します。タスク ID とチェックタイプを指定することで、タスクの進行状況（例：「保留中」、「実行中」、「完了」、「失敗」）を取得できます。また、この操作では開始時刻および終了時刻、検出された問題の一覧も応答として返されます。リクエストで verbose=true を設定した場合、各チェックポイントごとの詳細な分析結果が返されます。これらの詳細には、チェックポイント名、説明、結果、および失敗理由が含まれており、問題の診断を支援します。 |
| GetTempFile | GetTempFile | 一時ファイルの詳細を取得します。 |
| GetTempFileTask | GetTempFileTask | 一時ファイルタスクの詳細を取得します。 |
| GetToken | GetToken | 指定された DSW インスタンスの一時的な認証情報を取得します。 |
| ListInstances | ListInstances | Distribution Switch (DSW) インスタンスのリストをクエリします。 |
| ListTempFiles | ListTempFiles | 一時ファイルをリスト表示します。 |
| QueryAutoShutdownPolicies | 自動シャットダウンポリシーをクエリします | 指定された実行中のインスタンスの自動シャットダウンポリシー情報を取得します。 |
| StartInstance | StartInstance | DSW インスタンスを起動します。 |
| StopInstance | StopInstance | DSW インスタンスを停止します。 |
| StopInstances | StopInstances | 複数のインスタンスを一括で停止します。 |
| UpdateInstance | UpdateInstance | DSW インスタンスのプロパティを更新します。 |
| UpdateTempFile | UpdateTempFile | 一時ファイルのプロパティを更新します。 |
| UpdateTempFileTask | UpdateTempFileTask | 一時ファイルタスクを更新します。 |