OpenAITask - PolarDB - Alibaba Cloud Documentation Center

Enables the PolarDB for AI feature for a cluster.

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
polardb:OpenAITask	update	DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group.	rg-************
DBClusterId	string	Yes	The cluster ID.	pc-****************
Username	string	No	The username used to access the database for which you want to enable the PolarDB for AI feature.	testAccountName
Password	string	No	The password used to access the database for which you want to enable the PolarDB for AI feature.	testPassword
NodeType	string	No	The node type. Valid values: DLNode: This node is an AI node. SearchNode: This node is a node for which the PolarDB for AI feature is enabled.	DLNode
RegionId	string	Yes	The ID of the region.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	9B7BFB11-C077-4FE3-B051-F69CEB******
TaskId	string	The task ID.	53879cdb-9a00-428e-acaf-ff4cff******

Examples

Sample success responses

JSONformat

{
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissParameter.NodeType	The parameter nodeType is needed.	The NodeType parameter must be specified.
400	InvalidParameter.NodeType	The parameter NodeType is not valid.	The specified NodeType parameter is invalid.
400	CallDB4AI.Error	Call db4ai api error.	An error occurred when the DB4AI API is called
404	InvalidDBCluster.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.
500	InvalidAccount.Malformed	The specified parameter account or password is not valid.	The specified account or password is invalid.
500	InvalidAINode.NotFound	The AINode provided does not exist in our records.	The AI node cannot be found.

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

Change history

Change time	Summary of changes	Operation
2023-11-07	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-09-13	The Error code has changed	View Change Details
2023-07-25	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-07-20	The Error code has changed. The request parameters of the API has changed	View Change Details