DeleteJobs API による E-HPC ジョブの一括削除 - E-HPC Instant

指定されたクラスターから 1 つ以上のジョブを削除します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ehpc:DeleteJobs

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
JobSpec	array<object>	任意	削除対象のジョブに関する情報です。
	array<object>	任意	削除対象のジョブに関する情報です。
JobId	string	任意	削除対象のジョブ ID です。ジョブ ID は、ListJobs 操作を呼び出してクエリできます。	job-xxxx
TaskSpec	array<object>	任意	削除対象のジョブのタスク詳細です。
	object	任意	削除対象のジョブのタスク詳細です。
TaskName	string	任意	削除対象のタスク名です。	task0
ArrayIndex	array	任意	削除対象の配列ジョブインデックスのリストです。
	integer	任意	配列ジョブのインデックスです。	1
ExecutorIds	array	任意	エグゼキュータ ID のリストです。最大 100 個の ID がサポートされます。
	string	任意	エグゼキュータ ID です。形式は JobId-TaskName-ArrayIndex です。	job-xxxx-Task0-1
JobScheduler	string	任意	ジョブスケジューラのタイプです。 HPC K8S デフォルト値：HPC	HPC

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ
RequestId	string	リクエスト ID です。	04F0F334-1335-436C-A1D7-6C044FE7****

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParams	The specified parameter %s is invalid.
400	JobNotFound	The specified job id is not found.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.
406	DbError	A database error occurred.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。