DescribeForecastAgent - 获取推演预测实例详情 - 数据管理 DMS

获取 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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。