CreateInspectionTask-阿里云帮助中心

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

rdsai:CreateInspectionTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The beginning of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.	2025-12-28T16:00:00Z
EndTime	string	No	The end of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.	2026-01-30T02:10:48Z
InstanceIds	string	No	The IDs of the instances to inspect. Separate multiple instance IDs with a comma.	rm-2ze6mk259v322**,rm-2zef3b65430j0**
InspectionItems	string	No	The inspection items to run, separated by commas. If this parameter is omitted, all inspection items are run. Inspection items `instance_info` (instance information) `resource_usage` (resource usage) `connection_session_management` (connection and session management) `performance_metrics` (performance metrics) `slow_query_analysis` (slow query analysis) `error_log_analysis` (error log analysis) `lock_wait_deadlock_analysis` (lock wait and deadlock analysis) `backup_recovery_analysis` (backup and recovery analysis) `high_availability_disaster_recovery_analysis` (high availability and disaster recovery inspection) `security_configuration_analysis` (security configuration inspection) `storage_engine_analysis` (storage engine inspection) `schema_object_analysis` (schema and object inspection)	instance_info, resource_usage
ReportLanguage	string	No	The language of the inspection report. Valid values are zh-CN (Simplified Chinese) and en-US (English). The default value is en-US.
ReportType	string	No	The format of the inspection report. Valid values are pdf and json. The default value is pdf.
RegionId	string	No	The region ID.

Response elements

Element	Type	Description	Example
	object	The data returned.
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.	任务创建成功
Data	object	The response data.
TaskId	string	The ID of the inspection task.	9adf8567-b619-4d37-8ff2-01d38a76****
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "任务创建成功",
  "Data": {
    "TaskId": "9adf8567-b619-4d37-8ff2-01d38a76****"
  },
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Request parameter validation failed.	Request parameter verification failed
500	InternalError	System internal exception.	System internal exception
403	PermissionDenied	User has no operation permission.	User has no operation permission
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID
404	TaskNotFound	The resource of the specified ld does not exist.	The resource of the specified ld does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.