All Products
Search

This Product

    Data Management:CreateForecastAgent

    Document Center

    Data Management:CreateForecastAgent

    Last Updated:Aug 25, 2026

    Creates a forecast agent instance.

    Operation description

    Creates an asset inventory task. You can select instances, databases, or tables as the dimension for knowledge inventory. The task ID is returned.

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

    create

    *All Resource

    *

    		 None 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
    DryRun

    boolean

    No

    Specifies whether to enable the DryRun mode. Valid values:

    • true: enables the DryRun mode.

    • false (default): disables the DryRun mode.

    The DryRun mode is used to test API calls and verify whether you have the required permissions on the corresponding resources and whether the request parameters are correctly configured. When the DryRun mode is enabled, KMS always returns a failure and the failure reason. The failure reasons include the following:

    • DryRunOperationError: The request would succeed if the DryRun parameter is not specified.

    • ValidationError: The parameters specified in the request are invalid.

    • AccessDeniedError: You are not authorized to perform this operation on the KMS resource.

    True

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    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 was successful.

    • false: The request failed.

    true
    ErrorCode

    string

    The error code.

    UnknownError
    Message

    string

    The error message returned when the request failed.

    UnknownError
    Root

    object

    The Dify-related information.

    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 service region of DMS used to invoke this operation. For valid values, see RegionID parameter description.

    Note

    Select the region closest to your application.

    cn-chengdu
    Status

    string

    The status of the Dify instance. Valid values: DEPLOYED (running) and unconfigured.

    DEPLOYED
    CurrentStep

    string

    The current step number of the task.

    PRE_CHECK
    TaskId

    string

    The task ID.

    t-0002kwya4y5ydqvuof6b
    ImageVersion

    string

    The image version.

    Note

    If you specify an instance ID (InstanceId) and the image of the instance is an Alibaba Cloud Marketplace image or a custom image created from an Alibaba Cloud Marketplace image, this parameter must be the same as the ImageVersion of the current instance image or left empty.

    3.5.3.925
    FailureMessage

    string

    The failure message. This field is returned when the creation fails.

    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.