すべてのプロダクト
Search

このプロダクト

    Platform For AI:GetSanityCheckTask

    ドキュメントセンター

    Platform For AI:GetSanityCheckTask

    最終更新日:Feb 25, 2026

    ヘルスチェックタスクのステータスおよび結果を照会します。タスク ID とチェックタイプを指定することで、タスクの進行状況（例：「保留中」、「実行中」、「完了」、「失敗」）を取得できます。また、この操作では開始時刻および終了時刻、検出された問題の一覧も応答として返されます。リクエストで verbose=true を設定した場合、各チェックポイントごとの詳細な分析結果が返されます。これらの詳細には、チェックポイント名、説明、結果、および失敗理由が含まれており、問題の診断を支援します。

    今すぐお試しください

    この 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:GetSanityCheckTask

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v2/sanitychecks/{CheckType}/{TaskId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CheckType

    string

    任意

    チェック項目の種類です。有効な値は以下のとおりです。

    SSH：インスタンスに対して SSH ヘルスチェックをトリガーします。

    列挙値:

    • SSH :

      SSH

    SSH
    TaskId

    string

    任意

    ヘルスチェックタスクの ID です。

    917479ff-c869-49ea-908e-ae85bd987bc0

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Verbose

    boolean

    任意

    ヘルスチェックの詳細情報を応答に含めるかどうかを指定します。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答本文です。

    requestId

    string

    リクエストの ID です。

    44FB0869-AA85-599D-A09D-C42F7467618A
    TaskId

    string

    ヘルスチェックタスクの ID です。

    917479ff-c869-49ea-908e-ae85bd987bc0
    InstanceId

    string

    Data Science Workshop (DSW) インスタンスの ID です。

    dsw-730xxxxxxxxxx
    CheckType

    string

    チェックの種類です。有効な値は以下のとおりです。

    SSH：インスタンスに対して SSH ヘルスチェックをトリガーします。

    SSH
    Status

    string

    ヘルスチェックタスクのステータスです。

    Executing
    StartTime

    string

    タスクの開始時刻です（該当する場合）。

    2020-11-08T15:00:00Z
    EndTime

    string

    タスクの終了時刻です（該当する場合）。

    2020-11-08T15:00:00Z
    Issues

    array

    チェック中に検出された問題です。問題が検出されなかった場合は、空の配列が返されます。

    string

    検出されたヘルス関連の問題です。

    sshd has not been installed"
    CheckDetails

    array<object>

    ヘルスチェックタスクの分析結果です。

    object

    ヘルスチェックタスクの分析結果です。

    Name

    string

    チェック項目の名称です。

    secureGroupCheck
    Description

    string

    チェック項目の詳細な説明です。

    Check whether the security group allows traffic on port 22
    Result

    string

    チェックの結果です。

    passed
    Reason

    string

    チェック項目が失敗した理由です。

    Port 22 is blocked by the security group

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "44FB0869-AA85-599D-A09D-C42F7467618A",
  "TaskId": "917479ff-c869-49ea-908e-ae85bd987bc0",
  "InstanceId": "dsw-730xxxxxxxxxx",
  "CheckType": "SSH",
  "Status": "Executing",
  "StartTime": "2020-11-08T15:00:00Z",
  "EndTime": "2020-11-08T15:00:00Z",
  "Issues": [
    "sshd has not been installed\""
  ],
  "CheckDetails": [
    {
      "Name": "secureGroupCheck",
      "Description": "Check whether the security group allows traffic on port 22",
      "Result": "passed",
      "Reason": "Port 22 is blocked by the security group"
    }
  ]
}

    エラーコード

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

    変更履歴

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