DescribeAITaskStatus - PolarDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the status of the PolarDB for AI feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
polardb:DescribeAITaskStatus	get	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	pc-xxxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBClusterId	string	The cluster ID.	pc-xxxxxxxxxx
RequestId	string	The request ID.	9B7BFB11-C077-4FE3-B051-F69CEB******
Status	string	The status of the PolarDB for AI feature. Valid values: 1: enabled. 2: disabled.	1
StatusName	string	The description of the status of the PolarDB for AI feature.	Closed State
AccountName	string	The name of the database account that is used to connect to the AI nodes in the cluster.

Examples

Sample success responses

JSONformat

{
  "DBClusterId": "pc-xxxxxxxxxx",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "Status": "1",
  "StatusName": "Closed State",
  "AccountName": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	CallDB4AI.Error	Call db4ai api error.	An error occurred when the DB4AI API is called
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details
2022-08-01	Add Operation	View Change Details