DescribeForecastAgent - Data Management

取得 forecast agent 執行個體詳細資訊。

介面說明

僅管控模式為安全協同的資料庫執行個體可呼叫此 API。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:DescribeForecastAgent

get

*全部資源。

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
InstanceUuid	string	否	復原目標伺服器資料庫備份用戶端唯一識別碼。說明呼叫 DescribeUniBackupDatabase 介面可以取得該參數。	j1e98rqubjltx4
DataRegion	string	否	資料湖所屬的地域。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	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	伺服器資料庫備份用戶端唯一識別碼。	1f12594c-c0bf-65d0-bc6a-8d79caeaddb4
RegionId	string	選擇 DMS 的服務地域，用於呼叫該介面，取值請參見 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 parameter: aliyunParentUid
ImageVersion	string	映像版本。	1.0.0

樣本

正常返回樣本

JSON格式

{
  "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 parameter: aliyunParentUid",
    "ImageVersion": "1.0.0"
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。