CreateStorageAnalysisTask - Database Autonomy Service - Alibaba Cloud Documentation Center

Creates a storage analysis task to query the usage details of one or more databases and tables.

Operation description

This operation is applicable only to ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters.
If you use an Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call DAS, you must set the region to cn-shanghai.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:CreateStorageAnalysisTask	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze1jdv45i7l6****
NodeId	string	No	The node ID. Note This parameter is reserved.	23302528
DbName	string	No	The database name. If you specify a database, the operation analyzes the storage usage of the specified database.	testdb01
TableName	string	No	The table name. If you specify a table in the specified database, the operation analyzes the storage usage of the specified table. If you specify a table, you must also specify the database to which the table belongs by using DbName.	test_table

Response parameters

Parameter	Type	Description	Example
	object
Code	long	The HTTP status code returned.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. Otherwise, an error message such as an error code is returned.	Successful
Data	object	The returned data.
TaskId	string	The task ID.	910f83f4b96df0524ddc5749f61539f8
CreateTaskSuccess	boolean	Indicates whether the task is created. Valid values: true false	false
ErrorMessage	string	The error message returned.	unknown error
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indicates whether the request is successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TaskId": "910f83f4b96df0524ddc5749f61539f8",
    "CreateTaskSuccess": false,
    "ErrorMessage": "unknown error"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.