すべてのプロダクト
Search
ドキュメントセンター

Data Management:DescribeForecastAgent

最終更新日:Aug 25, 2026

予測エージェントインスタンスの詳細を取得します。

操作説明

この API を呼び出しできるのは、コントロールモードがセキュリティコラボレーションのデータベースインスタンスのみです。

今すぐお試しください

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

get

*すべてのリソース。

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceUuid

string

任意

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

説明

このパラメーターを取得するには、 DescribeUniBackupDatabase 操作を呼び出します。

j1e98rqubjltx4

DataRegion

string

任意

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

cn-hangzhou

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

RequestId

string

リクエスト ID。

EE214ECD-4330-503A-82F0-FFB039757DC8

HttpStatusCode

integer

HTTP 状態コード。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true: リクエストが成功しました。

  • false: リクエストが失敗しました。

true

ErrorCode

string

エラーコード。

UnknownError

Message

string

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

UnknownError

Root

object

Dify 関連情報。

InstanceUuid

string

サーバー上の Database Backup クライアントの一意の識別子。

1f12594c-c0bf-65d0-bc6a-8d79caeaddb4

RegionId

string

この操作の呼び出しに使用される DMS サービスのリージョン ID。詳細については、「RegionID パラメーターの説明」をご参照ください。

説明

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

cn-chengdu

Status

string

Dify インスタンスのステータス (DEPLOYED (実行中) や未設定など)。

DEPLOYED

CurrentStep

string

タスクの現在のステップ (PRE_CHECK、TRANSFER_PRECHECK、PREPARE、STRUCT_TRANSFER、STRUCT_MIGRATION、INDEX_MIGRATION、INDEX_TRANSFER、STRUCT_SYNC、FULL_MIGRATION、FULL_TRANSFER、APP_SWITCH、TRANSFER_APP_SWITCH、REVERSE_INCR_SYNC、REVERSE_INCR_TRANSFER、FULL_VALIDATION、FULL_VERIFIER、INCR_LOG_PULL、TRANSFER_INCR_LOG_PULL、INCR_SYNC、INCR_TRANSFER、INCR_VERIFIER、SYNC_PREPARE、TRANSFER_PREPARE、SYNC_INCR_LOG_PULL、CONNECTOR_FULL_SYNC、CONNECTOR_INCR_SYNC)。

PRE_CHECK

TaskId

string

タスク ID。

238079357365760

FailureMessage

string

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

missing パラメーター: aliyunParentUid

ImageVersion

string

イメージバージョン。

1.0.0

成功レスポンス

JSONJSON

{
  "RequestId": "EE214ECD-4330-503A-82F0-FFB039757DC8",
  "HttpStatusCode": 200,
  "Success": true,
  "ErrorCode": "UnknownError。",
  "Message": "UnknownError。",
  "Root": {
    "InstanceUuid": "1f12594c-c0bf-65d0-bc6a-8d79caeaddb4",
    "RegionId": "cn-chengdu。",
    "Status": "DEPLOYED。",
    "CurrentStep": "PRE_CHECK。",
    "TaskId": "238079357365760",
    "FailureMessage": "missing パラメーター: aliyunParentUid",
    "ImageVersion": "1.0.0"
  }
}

エラーコード

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

変更履歴

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