GetForecastAgentInstance - Data Management - Alibaba Cloud Documentation Center

Retrieves the list of forecast agents.

Operation description

Note: Deleting an instance removes it from the DMS instance list only. This operation does not delete or deactivate your instance.

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:GetForecastAgentInstance

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
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	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	UnknownError
Message	string	The error message returned if the request failed.	UnknownError
Root	object	The Dify-related information.
Exists	boolean	Indicates whether the budget name already exists.	True
Instances	array<object>	The instance alias.
	object	If the permission source is an access policy, this field contains the name of the access policy and the operations that the user is allowed to perform.
InstanceUuid	string	The unique identifier of the database backup client on the destination server for restoration. Note You can call the DescribeUniBackupDatabase operation to obtain this parameter.	***
RegionId	string	The DMS service region. For valid values, see RegionID parameter description. Note Select the region closest to your application.	cn-hangzhou
Status	string	The filter condition for task running status groups.	ON_LINE
CurrentStep	string	The current step number of the task.	PRE_CHECK
TaskId	string	The task ID.	201806739596800
FailureMessage	string	The failure message. This field is returned if the creation failed.	forecast agent provision failed, id
ImageVersion	string	The image version.	xuanwoali69a-80C320G-20250606-slave0527

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.