すべてのプロダクト
Search

このプロダクト

    Data Management:GetForecastAgentInstance

    ドキュメントセンター

    Data Management:GetForecastAgentInstance

    最終更新日:Aug 25, 2026

    予測エージェントのリストを取得します。

    操作説明

    注: インスタンスを削除しても、DMS のインスタンスリストから削除されるだけです。この操作では、インスタンスの削除や無効化は行われません。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:GetForecastAgentInstance

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DataRegion

    string

    任意

    データレイクが存在するリージョン。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrorCode

    string

    エラーコード。

    UnknownError
    Message

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    UnknownError
    Root

    object

    Dify 関連情報。

    Exists

    boolean

    予算名がすでに存在するかどうかを示します。

    True
    Instances

    array<object>

    インスタンスのエイリアス。

    object

    権限のソースがアクセスポリシーである場合、このフィールドにはアクセスポリシーの名前とユーザーが実行できる操作が含まれます。

    InstanceUuid

    string

    復元用の送信先サーバー上の Database Backup クライアントの一意の識別子。

    説明

    DescribeUniBackupDatabase 操作を呼び出してこのパラメーターを取得できます。

    ***
    RegionId

    string

    DMS サービスのリージョン。有効な値については、「RegionID パラメーターの説明」をご参照ください。

    説明

    アプリケーションに最も近いリージョンを選択してください。

    cn-hangzhou
    Status

    string

    タスクの実行中ステータスグループのフィルター条件。

    ON_LINE
    CurrentStep

    string

    タスクの現在のステップ番号。

    PRE_CHECK
    TaskId

    string

    タスク ID。

    201806739596800
    FailureMessage

    string

    失敗メッセージ。作成に失敗した場合にこのフィールドが返されます。

    予測エージェントのプロビジョニングが失敗しました, id
    ImageVersion

    string

    イメージバージョン。

    xuanwoali69a-80C320G-20250606-slave0527

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "HttpStatusCode": 200,
  "Success": true,
  "ErrorCode": "UnknownError",
  "Message": "UnknownError",
  "Root": {
    "Exists": true,
    "Instances": [
      {
        "InstanceUuid": "***",
        "RegionId": "cn-hangzhou",
        "Status": "ON_LINE",
        "CurrentStep": "PRE_CHECK",
        "TaskId": "201806739596800",
        "FailureMessage": "forecast agent provision failed, id",
        "ImageVersion": "xuanwoali69a-80C320G-20250606-slave0527"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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