全部產品
Search
文件中心

Data Management:GetForecastAgentInstance

更新時間:Aug 25, 2026

取得 forecast agent 清單。

介面說明

注意:刪除執行個體是指將執行個體從 DMS 執行個體清單中移除,不會導致您的執行個體被刪除或下線。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetForecastAgentInstance

get

*全部資源。

*

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

DataRegion

string

資料湖所屬的地域。

cn-hangzhou

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

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

復原目標伺服器資料庫備份用戶端唯一識別碼。

說明

呼叫 DescribeUniBackupDatabase 介面可以取得該參數。

***

RegionId

string

DMS 服務地域,取值請參見 RegionID 參數說明

說明

請根據應用程式所在地就近選擇。

cn-hangzhou

Status

string

任務執行狀態群組篩選條件。

ON_LINE

CurrentStep

string

任務目前操作步數。

PRE_CHECK

TaskId

string

任務 ID。

201806739596800

FailureMessage

string

失敗訊息。建立失敗後,返回該欄位。

forecast agent provision failed, id

ImageVersion

string

映像版本。

xuanwoali69a-80C320G-20250606-slave0527

樣本

正常返回樣本

JSON格式

{
  "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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情