SetForecastAgentInstance - Data Management - Alibaba Cloud Documentation Center

Operation description

Note: Deleting an instance removes the instance from the DMS instance list. This operation does not delete or take your instance offline.

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

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 backup client for the destination server database restoration. Note Call the DescribeUniBackupDatabase operation to obtain this parameter.	v1dhf8mn8i298s
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	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request is 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 request failed.	UnknownError
Root	object	The Dify-related information.
InstanceUuid	string	The instance identity.	dcf4bf7c47f011ef800000163e1474a0
ForecastAgentIdentity	string	The instance identity identifier.	dcf4bf7c47f011ef800000163e1474a0

Examples

Success response

JSON format

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "HttpStatusCode": 200,
  "Success": true,
  "ErrorCode": "UnknownError",
  "Message": "UnknownError",
  "Root": {
    "InstanceUuid": "dcf4bf7c47f011ef800000163e1474a0",
    "ForecastAgentIdentity": "dcf4bf7c47f011ef800000163e1474a0"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.