GetSanityCheckTask-阿里云帮助中心

Queries the status and results of a health check task. You can provide the task ID and check type to retrieve the task's progress, such as Pending, Executing, Completed, or Failed. The operation also returns the start and end times and a list of found issues. If you set verbose=true in the request, detailed analysis results for each checkpoint are returned. These details include the checkpoint name, description, result, and failure reason to help you diagnose problems.

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

paidsw:GetSanityCheckTask

get

*All Resource

*

None

Request syntax

GET /api/v2/sanitychecks/{CheckType}/{TaskId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
CheckType	string	No	The type of check item. Valid values: SSH: Triggers an SSH health check for the instance. Valid values: SSH : SSH	SSH
TaskId	string	No	The ID of the health check task.	917479ff-c869-49ea-908e-ae85bd987bc0

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Specifies whether to return the details of the health check.	true

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The ID of the request.	44FB0869-AA85-599D-A09D-C42F7467618A
TaskId	string	The ID of the health check task.	917479ff-c869-49ea-908e-ae85bd987bc0
InstanceId	string	The ID of the Data Science Workshop (DSW) instance.	dsw-730xxxxxxxxxx
CheckType	string	The type of check. Valid value: SSH: Triggers an SSH health check for the instance.	SSH
Status	string	The status of the health check task.	Executing
StartTime	string	The time when the task started, if available.	2020-11-08T15:00:00Z
EndTime	string	The time when the task ended, if available.	2020-11-08T15:00:00Z
Issues	array	The issues found during the check. If no issues are found, an empty array is returned.
	string	A health issue that was found.	sshd has not been installed"
CheckDetails	array<object>	The analysis results of the health check task.
	object	The analysis results of the health check task.
Name	string	The name of the check item.	secureGroupCheck
Description	string	The detailed description of the check item.	Check whether the security group allows traffic on port 22
Result	string	The result of the check.	passed
Reason	string	The reason why the check item failed.	Port 22 is blocked by the security group

Examples

Success response

JSON format

{
  "requestId": "44FB0869-AA85-599D-A09D-C42F7467618A",
  "TaskId": "917479ff-c869-49ea-908e-ae85bd987bc0",
  "InstanceId": "dsw-730xxxxxxxxxx",
  "CheckType": "SSH",
  "Status": "Executing",
  "StartTime": "2020-11-08T15:00:00Z",
  "EndTime": "2020-11-08T15:00:00Z",
  "Issues": [
    "sshd has not been installed\""
  ],
  "CheckDetails": [
    {
      "Name": "secureGroupCheck",
      "Description": "Check whether the security group allows traffic on port 22",
      "Result": "passed",
      "Reason": "Port 22 is blocked by the security group"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.