API 標準および多言語対応の SDK
本製品 (MaxCompute/2022-01-04) の 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 |
タイトル |
説明 |
| CreateQuota | クォータを作成します。 | クォータを作成します。MaxCompute を初めてアクティブ化する場合、最初に従量課金クォータを作成する必要があります。サブスクリプションクォータを作成する場合、自動支払いが差し引かれます。 |
| ListQuotas | ListQuotas | この操作は、クォータのリストを照会します。 |
| QueryQuota | QueryQuota | 指定されたレベル 1 クォータグループに関する情報を照会します。 |
| GetQuota | GetQuota | 指定されたレベル 1 クォータグループに関する情報を取得します。警告: この操作は 2024 年 7 月 31 日に非公開になり、QueryQuota 操作に置き換えられます。 2 つの操作のリクエストパラメーター、レスポンスパラメーター、および機能は同じです。 |
| 計算クォータの設定 | 計算クォータの設定 | |
| CreateComputeQuotaPlan | CreateComputeQuotaPlan | クォータプランを作成します。 |
| UpdateComputeSubQuota | UpdateComputeSubQuota | MaxCompute クォータの基本構成を更新します。例えば、この操作を呼び出すことで、レベル 2 クォータの追加や削除、レベル 2 クォータの基本属性の定義、有効なクォータプランに対する計算ユニット (CU) の構成定義などが可能です。 |
| GetComputeQuotaPlan | GetComputeQuotaPlan | 単一のコンピューティングクォータプランの詳細情報を取得します。 |
| ListComputeQuotaPlan | ListComputeQuotaPlan | コンピューティングクォータプランを一覧表示します。 |
| UpdateComputeQuotaPlan | UpdateComputeQuotaPlan | コンピューティングクォータプランを更新します。 |
| DeleteComputeQuotaPlan | DeleteComputeQuotaPlan | MaxCompute のクォータプランを削除します。 |
| ApplyComputeQuotaPlan | ApplyComputeQuotaPlan | クォータプランを即時アクティブ化します。 |
| GetComputeQuotaSchedule | GetComputeQuotaSchedule | コンピューティングクォータの時間指定構成を表示します。 |
| UpdateComputeQuotaSchedule | UpdateComputeQuotaSchedule | 計算クォータの時間ベースのスケジュールを更新します。 |
| GetComputeEffectivePlan | GetComputeEffectivePlan | GetComputeEffectivePlan。 |
| トンネルクォータの時間ベース設定 | トンネルクォータの時間ベース設定 | |
| 計算クォータの設定 (レガシ、非推奨) | 計算クォータの設定 (レガシ、非推奨) | |
| CreateQuotaPlan | CreateQuotaPlan | クォータプランを作成します。 |
| GetQuotaPlan | GetQuotaPlan | クォータプランの情報を取得します。 |
| UpdateQuotaPlan | UpdateQuotaPlan | クォータプランを更新します。 |
| ListQuotasPlans | ListQuotasPlans | クォータプランを取得します。 |
| DeleteQuotaPlan | DeleteQuotaPlan | クォータプランを削除します。 |
| UpdateQuotaSchedule | UpdateQuotaSchedule | クォータプランのスケジューリングプランを更新します。 |
| GetQuotaSchedule | GetQuotaSchedule | クォータプランのスケジュールプランを取得します。 |
プロジェクト管理
|
API |
タイトル |
説明 |
| 基本管理 (Project) | 基本管理 (Project) | |
| UpdateProjectBasicMeta | UpdateProjectBasicMeta | プロジェクトの基本情報を変更します。 |
| UpdateProjectDefaultQuota | UpdateProjectDefaultQuota | プロジェクトのデフォルトのコンピューティングクォータを更新します。 |
| UpdateProjectIpWhiteList | UpdateProjectIpWhiteList | MaxCompute プロジェクトの IP アドレスホワイトリストを変更します。 |
| UpdateProjectModelTier | UpdateProjectModelTier | プロジェクトのレイヤー 2 モデルをレイヤー 3 モデルにアップグレードします。 |
| GetTrustedProjects | GetTrustedProjects | 現在のプロジェクトの信頼できるプロジェクトを取得します。 |
| ロールと権限 (Role、user) | ロールと権限 (Role、user) | |
| DeleteRole | DeleteRole | MaxCompute でプロジェクトレベルのロールを削除します。 |
| ListProjectUsers | ListProjectUsers | プロジェクト内のユーザーのリストを照会します。 |
| CreateRole | CreateRole | MaxCompute プロジェクトレベルでロールを作成します。 |
| GetRoleAcl | GetRoleAcl | プロジェクトレベルのロールに付与されている ACL ベースの権限を取得します。 |
| GetRoleAclOnObject | GetRoleAclOnObject | プロジェクトレベルのロールに付与された、オブジェクトに対する ACL ベースの権限を取得します。 |
| GetRolePolicy | GetRolePolicy | プロジェクトレベルのロールにアタッチされているポリシーを取得します。 |
| ListUsersByRole | ListUsersByRole | プロジェクトレベルのロールを割り当てられたユーザーに関する情報を取得します。 |
| UpdateUsersToRole | UpdateUsersToRole | プロジェクト ロールにユーザーを追加または削除します。 |
| パッケージ | パッケージ | |
| ListPackages | ListPackages | MaxCompute プロジェクト内のパッケージを照会します。 |
| UpdatePackage | UpdatePackage | パッケージ内のオブジェクトと、パッケージをインストールできるプロジェクトを更新します。 |
| CreatePackage | CreatePackage | パッケージを作成します。 |
| GetPackage | GetPackage | パッケージに関する情報を取得します。 |
| テーブル (Table) | テーブル (Table) | |
| GetTableInfo | GetTableInfo | MaxCompute の内部テーブル、ビュー、外部テーブル、クラスター化テーブル、またはトランザクションテーブルに関する情報を表示します。 |
リソース監視
|
API |
タイトル |
説明 |
| QueryQuotaMetric | QueryQuotaMetric | クォータのリソース消費の時系列データをクエリします。 |
| QueryTunnelMetricDetail | QueryTunnelMetricDetail | 指定された時間範囲におけるトンネルデータ転送サービスの詳細を照会します。 |
| QueryTunnelMetric | QueryTunnelMetric | 指定された時間範囲内の Tunnel Data Transmission Service のメトリックデータをクエリします。 |
| GetQuotaUsage | GetQuotaUsage | クォータリソースの使用状況情報をクエリします。 |
| ListJobMetric | ListJobMetric | 完了したジョブのパフォーマンスメトリックを問い合わせます。 |
| QueryStorageMetric | QueryStorageMetric | データストレージの時系列メトリックをクエリします。 |
| ListStorageTablesInfo | ListStorageTablesInfo | MaxCompute プロジェクトのテーブルストレージの詳細をクエリします。 |
| ListStoragePartitionsInfo | ListStoragePartitionsInfo | MaxCompute プロジェクト内のパーティションテーブルにあるパーティションのストレージ詳細を取得します。 |
| GetStorageSizeSummary | GetStorageSizeSummary | ストレージ使用量の要約を取得します。 |
| GetStorageAmountSummary | GetStorageAmountSummary | ストレージ総量の要約を取得します。 |
| GetStorageSummaryCompared | GetStorageSummaryCompared | ストレージ使用量の年間変化率を取得します。 |
| ListStorageProjectsInfo | ListStorageProjectsInfo | プロジェクトのストレージの詳細を取得します。 |
タスクの運用保守
|
API |
タイトル |
説明 |
| ListJobInfos | ListJobInfos | ジョブのリストを取得します。 |
| ListJobSnapshotInfos | ListJobSnapshotInfos | 特定の時点におけるジョブスナップショットデータを取得します。 |
| GetJobInfo | GetJobInfo | ジョブの基本情報を照会します。 |
| GetRunningJobs | GetRunningJobs | 指定された期間において、実行中のジョブの実行状態データを取得します。 |
| KillJobs | KillJobs | 実行中のジョブを終了させます。 |
| GetJobResourceUsage | GetJobResourceUsage | 指定した日に完了したすべてのジョブの統計を日単位で実行し、各ジョブエグゼキュータの合計リソース使用量を取得します。 |
データ移行
|
API |
タイトル |
説明 |
| RetryMmsTask | RetryMmsTask | 移行タスクをリトライします。 |
| CreateMmsDataSource | CreateMmsDataSource | MaxCompute Migration Assist (MMA) を使用して MaxCompute にデータを移行するためのデータソースを作成します。 |
| GetMmsDataSource | GetMmsDataSource | 単一の MaxCompute Migration Assist (MMA) データソースの詳細を取得します。 |
| ListMmsDataSources | ListMmsDataSources | MaxCompute Migration Assist (MMA) データソース |
| UpdateMmsDataSource | UpdateMmsDataSource | MaxCompute Migration Assist (MMA) データソースのメタデータを更新します。 |
| DeleteMmsDataSource | DeleteMmsDataSource | MaxCompute Migration Assist (MMA) データソースと、それに関連付けられた移行計画およびメタデータを削除します。 |
| CreateMmsFetchMetadataJob | CreateMmsFetchMetadataJob | データソースからメタデータをプルするジョブを作成します。 |
| GetMmsFetchMetadataJob | GetMmsFetchMetadataJob | MaxCompute Migration Assist（MMA）のメタデータを取得 ジョブの詳細を取得します。 |
| ListMmsDbs | ListMmsDbs | MMA データソース内のデータベースをリストします。 |
| GetMmsDb | GetMmsDb | MaxCompute Migration Assist (MMA) データソースからデータベースを取得します。 |
| ListMmsTables | ListMmsTables | MaxCompute Migration Assist (MMA) データソース内のテーブルを一覧表示します。 |
| GetMmsTable | GetMmsTable | MaxCompute Migration Assist (MMA) データソースからテーブルを取得します。 |
| ListMmsPartitions | ListMmsPartitions | MaxCompute Migration Assist (MMA) データソース内のパーティションを一覧表示します。 |
| GetMmsPartition | GetMmsPartition | MaxCompute Migration Assist (MMA) データソースからパーティションを取得します。 |
| CreateMmsJob | CreateMmsJob | データ移行タスクを作成します。 |
| ListMmsJobs | ListMmsJobs | 移行ジョブの一覧を取得します。 |
| GetMmsJob | GetMmsJob | MaxCompute Migration Assist (MMA) の移行計画の詳細を取得します。 |
| GetMmsAsyncTask | GetMmsAsyncTask | MaxCompute Migration Assist (MMA) から単一の非同期タスクを取得します。 |
| DeleteMmsJob | DeleteMmsJob | MaxCompute Migration Assist (MMA) データ移行プランを削除します。 |
| StartMmsJob | StartMmsJob | データ移行ジョブを開始します。 |
| StopMmsJob | StopMmsJob | データ移行ジョブを停止します。 |
| RetryMmsJob | RetryMmsJob | データ移行ジョブを再試行します。 |
| ListMmsTasks | データ移行タスクリストの取得。 | データ移行タスクのリストを取得します。 |
| GetMmsTask | GetMmsTask | 特定の移行タスクの詳細を取得します。 |
| ListMmsTaskLogs | ListMmsTaskLogs | 特定の移行タスクの実行ログを一覧表示します。 |
| CreateMmsTimer | CreateMmsTimer | CreateMmsTimer |
| UpdateMmsTimer | UpdateMmsTimer | 定期タスクの設定を更新します。 |
| UpdateMmsTables | UpdateMmsTables | テーブルのメタデータを更新します。 |
| UpdateMmsTable | UpdateMmsTable | テーブルのメタデータを更新します。 |
| UpdateMmsDb | UpdateMmsDb | 指定されたデータベースのメタデータを更新します。 |
| ListMmsTimers | ListMmsTimers | 指定されたデータソースのタイマーを一覧表示します。 |
| ListMmsTimerLogs | ListMmsTimerLogs | 特定のデータソースの定期タスクのログを一覧表示します。 |
| ListMmsDataSourceConfigItems | ListMmsDataSourceConfigItems | 指定されたデータソースタイプの設定項目をリストします。 |
| GetMmsTimer | GetMmsTimer | GetMmsTimer |
| DeleteMmsTimer | DeleteMmsTimer | 指定されたデータソースからタイマーを削除します。 |
コスト分析
|
API |
タイトル |
説明 |
| ListInstances | ListInstances | 指定された期間のコスト分析のために、プロジェクトのリストを取得します。 |
| SumStorageMetricsByType | SumStorageMetricsByType | ストレージタイプ別にストレージ使用量を集計します。 |
| ListComputeMetricsBySignature | ListComputeMetricsBySignature | シグネチャ別にジョブの詳細なコンピューティング使用量を表示します。 |
| SumComputeMetricsByUsage | SumComputeMetricsByUsage | スキャンされたデータ量または CU 使用量別にコンピューティング使用量を集計します。 |
| SumComputeMetricsByRecord | SumComputeMetricsByRecord | 使用量レコードの総数を計算します。 |
| SumDailyBillsByItem | SumDailyBillsByItem | インスタンスまたは課金項目ごとに、費用の日次内訳を表示します。 |
| SumBills | SumBills | インスタンスまたは課金項目ごとに費用情報を集計します。 |
| SumBillsByDate | SumBillsByDate | インスタンスまたは課金項目でグループ化された日次コストサマリーを取得します。 |
| SumStorageMetricsByDate | SumStorageMetricsByDate | 指定された日付範囲内のストレージメトリックを、プロジェクトまたはストレージクラス別にグループ化して集計し、取得します。 |
| ListComputeMetricsByInstance | ListComputeMetricsByInstance | インスタンスごとのジョブのコンピューティング使用量を一覧表示します。 |
その他
|
API |
タイトル |
説明 |
| TriggerMmsTimer | TriggerMmsTimer | 特定のデータソースに対してタイマーをトリガーします。 |
| CreateProject | CreateProject | MaxCompute プロジェクトを作成します。 |
| DeleteProject | DeleteProject | MaxCompute プロジェクトを削除します。この操作は元に戻せないため、この API の呼び出しは慎重に行ってください。 |
| GetProject | GetProject | MaxComputeプロジェクトの基本情報を照会します。 |
| ListFunctions | ListFunctions | MaxCompute プロジェクト内の関数を取得します。 |
| ListProjects | ListProjects | MaxCompute プロジェクトのリストを取得します。 |
| ListResources | ListResources | MaxCompute プロジェクト内のリソースを取得します。 |
| ListRoles | ListRoles | MaxCompute プロジェクトレベルのロールを取得します。 |
| ListTables | ListTables | MaxCompute プロジェクト内のテーブルを取得します。 |
| ListUsers | ListUsers | MaxCompute プロジェクト内のユーザーを取得します。 |