DescribeForecastAgent - Data Management - Alibaba Cloud Documentation Center

Retrieves the details of a forecast agent instance.

Operation description

Only database instances whose control mode is Security Collaboration can call this API.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:DescribeForecastAgent

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceUuid	string	No	The unique identifier of the database backup client on the destination server. Note Call the DescribeUniBackupDatabase operation to obtain this parameter.	j1e98rqubjltx4
DataRegion	string	No	The region where the data lake resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	EE214ECD-4330-503A-82F0-FFB039757DC8
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code.	UnknownError
Message	string	The error message returned if the request failed.	UnknownError
Root	object	The Dify-related information.
InstanceUuid	string	The unique identifier of the database backup client on the server.	1f12594c-c0bf-65d0-bc6a-8d79caeaddb4
RegionId	string	The region ID of the DMS service used to invoke this operation. For more information, see RegionID parameter description. Note Select the region closest to your application.	cn-chengdu
Status	string	The status of the Dify instance, such as DEPLOYED (running) or unconfigured.	DEPLOYED
CurrentStep	string	The current step of the task (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	The task ID.	238079357365760
FailureMessage	string	The failure message. This field is returned if the creation fails.	missing parameter: aliyunParentUid
ImageVersion	string	The image version.	1.0.0

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.