API 標準および多言語対応の SDK
本製品 (emr-serverless-spark/2023-08-08) の 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 |
タイトル |
説明 |
| AddMembers | AddMembers | Resource Access Management (RAM) ユーザーまたは RAM ロールをメンバーとしてワークスペースに追加します。 |
| ListMembers | ListMembers | ListMembers 操作を呼び出して、ワークスペース内のメンバーのリストを表示できます。 |
| GrantRoleToUsers | GrantRoleToUsers | 指定されたロールをユーザーに割り当てます。 |
会話管理
|
API |
タイトル |
説明 |
| GetSessionCluster | GetSessionCluster | セッションの詳細を取得します。 |
| CreateSessionCluster | CreateSessionCluster | セッションクラスターを作成します。 |
| StopSessionCluster | StopSessionCluster | セッションを停止します。 |
| StartSessionCluster | StartSessionCluster | セッションクラスターを開始します。 |
| ListSessionClusters | ListSessionClusters | セッションクラスターのリストを取得します。 |
ゲートウェイ
|
API |
タイトル |
説明 |
| Kyuubi Gateway | Kyuubi Gateway | |
| ListKyuubiSparkApplications | ListKyuubiSparkApplications | Kyuubi Spark アプリケーションの一覧を取得します。 |
| CancelKyuubiSparkApplication | CancelKyuubiSparkApplication | Kyuubi Spark アプリケーションをキャンセルします。 |
| DeleteKyuubiToken | DeleteKyuubiToken | Kyuubi Gateway 認証トークンを削除します。 |
| UpdateKyuubiToken | UpdateKyuubiToken | Kyuubi Gateway の認証トークンを更新します。 |
| GetKyuubiToken | GetKyuubiToken | Kyuubi Gateway の認証トークンを取得します。 |
| CreateKyuubiToken | CreateKyuubiToken | Kyuubi ゲートウェイの認証トークンを作成します。 |
| ListKyuubiToken | ListKyuubiToken | KyuubiServer の認証トークンをリスト表示します。 |
| ListKyuubiServices | ListKyuubiServices | Kyuubi ゲートウェイをリストします。 |
| CreateKyuubiService | CreateKyuubiService | Kyuubi ゲートウェイを作成します。 |
| GetKyuubiService | GetKyuubiService | Kyuubi ゲートウェイの詳細を取得します。 |
| UpdateKyuubiService | UpdateKyuubiService | Kyuubi ゲートウェイを更新します。 |
| DeleteKyuubiService | DeleteKyuubiService | Kyuubi ゲートウェイを削除します。 |
| StartKyuubiService | StartKyuubiService | Kyuubi ゲートウェイを起動します。 |
| StopKyuubiService | StopKyuubiService | Kyuubi ゲートウェイを停止します。 |
| Livy Gateway | Livy Gateway | |
| ListLivyComputeSessions | ListLivyComputeSessions | Livy ゲートウェイの履歴セッションを一覧表示します。 |
| DeleteLivyCompute | DeleteLivyCompute | Livy ゲートウェイを削除します。 |
| CreateLivyCompute | CreateLivyCompute | Livy コンピュートを作成します。 |
| UpdateLivyCompute | UpdateLivyCompute | Livy Gateway を更新します。 |
| ListLivyCompute | ListLivyCompute | Livy ゲートウェイのリストを取得します。 |
| StartLivyCompute | StartLivyCompute | Livy ゲートウェイを起動します。 |
| RefreshLivyComputeToken | RefreshLivyComputeToken | Livy Gateway のトークンを更新します。 |
| GetLivyComputeToken | GetLivyComputeToken | Livy Gateway のトークンを取得します。 |
| CreateLivyComputeToken | CreateLivyComputeToken | Livy Gateway のトークンを作成します。 |
| DeleteLivyComputeToken | DeleteLivyComputeToken | Livy Gateway のトークンを削除します。 |
| StopLivyCompute | StopLivyCompute | Livy Gateway を停止します。 |
| ListLivyComputeToken | ListLivyComputeToken | Livy Gateway のトークンをリストします。 |
| GetLivyCompute | GetLivyCompute | Livy ゲートウェイに関する情報を取得します。 |
データ開発
|
API |
タイトル |
説明 |
| TerminateSqlStatement | TerminateSqlStatement | SQL クエリタスクを終了します。 |
| CreateSqlStatement | CreateSqlStatement | SQL 文を作成します。 |
| GetSqlStatement | GetSqlStatement | SQL クエリの詳細を取得します。 |
| ListSqlStatementContents | ListSqlStatementContents | SQL 文の内容を取得します。 |
ワークスペース管理
|
API |
タイトル |
説明 |
| ListWorkspaceQueues | ListWorkspaceQueues | ワークスペース内のキューを一覧表示します。 |
| EditWorkspaceQueue | EditWorkspaceQueue | ワークスペースキューを更新します。 |
Spark バージョン管理
|
API |
タイトル |
説明 |
| ListReleaseVersions | ListReleaseVersions | リリースバージョンのリストを取得します。 |
Spark ジョブ管理
|
API |
タイトル |
説明 |
| ListJobExecutors | ListJobExecutors | ジョブのエグゼキュータを一覧表示します。 |
| ListLogContents | Query Log Content | ログコンテンツの取得 |
| GetCuHours | GetCuHours | 指定されたサイクル中にキューによって消費された CU 時間を照会します。 |
| GetDoctorApplication | GetDoctorApplication | E-MapReduce (EMR) Doctor のジョブ分析情報を取得します。 |
| CancelJobRun | CancelJobRun | Spark ジョブを終了させます。 |
| ListJobRuns | ListJobRuns | ListJobRuns 操作を呼び出して、Spark ジョブのリストを取得します。 |
| GetJobRun | GetJobRun | ジョブの詳細を取得します。 |
| StartJobRun | StartJobRun | Spark ジョブを開始します。 |
| GetRunConfiguration | GetRunConfiguration | Spark ジョブの構成を取得します。 |
Ray ジョブ管理
|
API |
タイトル |
説明 |
| StartProcessInstance | StartProcessInstance | ワークフローを手動で開始します。 |
| UpdateProcessDefinitionWithSchedule | UpdateProcessDefinitionWithSchedule | ワークフロー定義とその時間指定スケジューリングを更新します。 |
| CreateProcessDefinitionWithSchedule | CreateProcessDefinitionWithSchedule | ワークフロー定義を作成します。 |
| GenerateTaskCodes | GenerateTaskCodes | ワークフローとそのスケジューリング構成を公開します。 |
ジョブオーケストレーション
|
API |
タイトル |
説明 |
| Ray クラスター | Ray クラスター | |
| UpdateRayCluster | UpdateRayCluster | Ray クラスターを更新します。 |
| GetRayCluster | GetRayCluster | Ray クラスターを取得します。 |
| ListRayCluster | ListRayCluster | Ray クラスターを一覧表示します。 |
| StopRayCluster | StopRayCluster | Ray クラスターを停止します。 |
| StartRayCluster | StartRayCluster | Ray クラスターを起動します。 |
| DeleteRayCluster | Ray クラスターを削除します | Ray クラスターを削除します。 |
| CreateRayCluster | CreateRayCluster | Ray クラスターを作成します。 |
クラスター管理
|
API |
タイトル |
説明 |
| ListNetworkServices | ListNetworkServices | ネットワーク接続を一覧表示します。 |
| CreateNetworkService | CreateNetworkService | ネットワークサービスを作成します。 |
ネットワーク接続
|
API |
タイトル |
説明 |
| ListCatalogs | ListCatalogs | データカタログのリストを表示します |
| ListExecutorLogs | ListExecutorLogs | ジョブエグゼキュータのログファイルを一覧表示します。 |
| GetCacheCluster | キャッシュクラスターの詳細を取得します | キャッシュクラスターの詳細を取得します。 |
| StartCacheCluster | キャッシュクラスターを起動します | キャッシュクラスターを起動します。 |
| StopCacheCluster | キャッシュクラスタを停止します | キャッシュクラスタを停止します。 |
| ActivateAICenter | ActivateAICenter | AI センターを有効化します。 |
| ChangeResourceGroup | ChangeResourceGroup | インスタンスを別のリソースグループに移動します。 |
| CreateWorkspace | CreateWorkspace | ワークスペースを作成します。 |
| GetAICenterState | GetAICenterState | AI センターの状態を取得します。 |
| GetTemplate | GetTemplate | タスクテンプレートを取得します。 |
| ListTemplate | ListTemplate | ジョブテンプレートを一覧表示します。 |
| ListWorkspaces | ListWorkspaces | ワークスペースの一覧を取得します。 |
| UpdateWorkspace | UpdateWorkspace | ワークスペースのプロパティを更新します。 |
その他
|
API |
タイトル |
説明 |
| GetRayLog | Ray タスクログを取得します。 | Ray タスクのログを取得します。 |
| ListRayLogs | Ray ログを一覧表示します。 | Ray ログを一覧表示します。 |