GetForecastAgentInstance

Retrieves a list of forecast agent instances.

Operation description

Note: Removing an instance only removes it from the Data Management Service (DMS) instance list. This operation does not delete or shut down 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DataRegion	string	No	The region where the data lake is located.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The 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 on failure.	UnknownError
Root	object	The data returned for the request.
Exists	boolean	Indicates whether the forecast agent instance exists.	True
Instances	array<object>	A list of forecast agent instances.
	object	A forecast agent instance.
InstanceUuid	string	The unique ID of the forecast agent instance. Note This ID can be obtained from the response of other instance management operations.	***
RegionId	string	The region where Data Management Service (DMS) is deployed. For more information about valid values, see RegionID parameter description. Note The value indicates the region where the instance is located.	cn-hangzhou
Status	string	The status of the instance.	ON_LINE
CurrentStep	string	The current step of the task.	PRE_CHECK
TaskId	string	The task ID.	201806739596800
FailureMessage	string	The message that is returned if the task fails.	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.