CreateForecastAgent

Creates a forecast agent.

Operation description

Creates a forecast agent. You can create the agent for an instance, a database, or a table. The operation returns a task ID.

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
DryRun	boolean	No	Specifies whether to perform a dry run. Set this to `true` to test the API call without making any changes. This checks if you have the required permissions and if the request parameters are valid. The default is `false`. When `DryRun` is `true`, the service returns a failure response with a reason, such as `DryRunOperationError` (the request would have succeeded), `ValidationError` (invalid parameters), or `AccessDeniedError` (insufficient permissions on the KMS resource).	True

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	427688B8-ADFB-4C4E-9D45-EF5C1FD6****
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request is successful. false: The request failed.	true
ErrorCode	string	The error code.	UnknownError
Message	string	The error message returned when the operation fails.	UnknownError
Root	object	Details of the forecast agent.
InstanceUuid	string	The unique ID of the forecast agent instance. Note	***
RegionId	string	The ID of the DMS service region. For a list of valid values, see region ID parameter description. Note Select a region that is geographically close to your application.	cn-chengdu
Status	string	The status of the forecast agent instance. Valid values include `DEPLOYED` (running) and `Not configured`.	DEPLOYED
CurrentStep	string	The current step of the task.	PRE_CHECK
TaskId	string	The task ID.	t-0002kwya4y5ydqvuof6b
ImageVersion	string	The image version. Note When specifying an `InstanceId` for an instance that uses a marketplace image or a custom image based on a marketplace image, this parameter is optional. If provided, its value must match the `ImageVersion` of the instance's current image.	3.5.3.925
FailureMessage	string	The error message returned on failure.	missing parameter: aliyunParentUid

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
  "HttpStatusCode": 200,
  "Success": true,
  "ErrorCode": "UnknownError",
  "Message": "UnknownError",
  "Root": {
    "InstanceUuid": "***",
    "RegionId": "cn-chengdu",
    "Status": "DEPLOYED",
    "CurrentStep": "PRE_CHECK",
    "TaskId": "t-0002kwya4y5ydqvuof6b",
    "ImageVersion": "3.5.3.925",
    "FailureMessage": "missing parameter: aliyunParentUid"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.