DSW インスタンスで SSH ヘルスチェックを実行しタスク ID で結果を取得 - PAI - Alibaba Cloud - Platform For AI

指定された DSW インスタンスの非同期ヘルスチェックタスクを送信します。チェックタイプ (SSH など) およびインスタンス ID を指定する必要があります。システムは、タスクがキューに追加されたことを示す一意のタスク ID (TaskID) を即座に返します。この操作はチェック結果を待たずに実行されるため、高速な応答が必要なシナリオに適しています。タスク ID を使用して、後から実行ステータスと詳細な結果をクエリできます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paidsw:CreateSanityCheckTask

create

*すべてのリソース。

*

なし

リクエスト構文

POST /api/v2/sanitychecks/{CheckType} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
CheckType	string	必須	確認項目のタイプ。有効な値: SSH: インスタンスの SSH 接続性ヘルスチェックをトリガーします。 CustomService: インスタンス上のカスタムサービスの接続性ヘルスチェックをトリガーします。	SSH

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。
InstanceId	string	必須	インスタンスの ID。インスタンス ID の取得方法については、「 ListInstances 」をご参照ください。	dsw-730xxxxxxxxxx
CheckArgs	object	任意	ヘルスチェックに必須の追加パラメーター。例: "ServiceName": チェック対象のカスタムサービスのサービス名

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	BEBDF2EE-642E-5992-8907-D2011A7ACEFE
TaskId	string	作成されたヘルスチェックタスクの ID。	917479ff-c869-49ea-908e-ae85bd987bc0

例

成功レスポンス

JSONJSON

{
  "RequestId": "BEBDF2EE-642E-5992-8907-D2011A7ACEFE\n",
  "TaskId": "917479ff-c869-49ea-908e-ae85bd987bc0"
}

エラーコード

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

変更履歴

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