CreateSanityCheckTask

Submits an asynchronous health check task for a specified DSW instance. When you call this operation, you must provide the check type, such as ssh, and the instance ID. The system immediately returns a unique task ID (TaskID) to indicate that the task is successfully queued. The operation is non-blocking and does not wait for the check result, which makes it suitable for scenarios that require a fast response. You can later use the task ID to query the execution status and detailed results.

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 /api/v2/sanitychecks/{CheckType} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
CheckType	string	Yes	The type of the check item. Valid value: SSH: Triggers a Secure Shell (SSH) health check for the instance.	SSH

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
InstanceId	string	Yes	The instance ID. For more information about how to obtain the instance ID, see ListInstances.	dsw-730xxxxxxxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	BEBDF2EE-642E-5992-8907-D2011A7ACEFE
TaskId	string	The ID of the created health check task.	917479ff-c869-49ea-908e-ae85bd987bc0

Examples

Success response

JSON format

{
  "RequestId": "BEBDF2EE-642E-5992-8907-D2011A7ACEFE\n",
  "TaskId": "917479ff-c869-49ea-908e-ae85bd987bc0"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.