SetForecastAgentInstance

Operation description

Note: This operation removes the instance from the DMS instance list. It does not delete the instance or take it 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

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
InstanceUuid	string	No	The unique ID of the client used to restore database backups on the target server. Note You can call the DescribeUniBackupDatabase operation to obtain this parameter.	v1dhf8mn8i298s
DataRegion	string	No	The region where the data lake is located.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	7FAD400F-7A5C-4193-8F9A-39D86C4F0231
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
ErrorCode	string	The error code.	UnknownError
Message	string	The error message returned if the request fails.	UnknownError
Root	object	Dify-related information.
InstanceUuid	string	The instance ID.	dcf4bf7c47f011ef800000163e1474a0
ForecastAgentIdentity	string	The identity of the forecast agent.	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.