All Products
Search

This Product

    PolarDB:OpenAITask

    Document Center

    PolarDB:OpenAITask

    Last Updated:Mar 21, 2024

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:OpenAITaskWrite
    • DBCluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-************
    DBClusterIdstringYes

    The cluster ID.

    		pc-****************
    UsernamestringNo

    The username used to access the database for which you want to enable the PolarDB for AI feature.

    		testAccountName
    PasswordstringNo

    The password used to access the database for which you want to enable the PolarDB for AI feature.

    		testPassword
    RegionIdstringYes

    The ID of the region.

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		9B7BFB11-C077-4FE3-B051-F69CEB******
    TaskIdstring

    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 codeError codeError messageDescription
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    500InvalidAccount.MalformedThe specified parameter account or password is not valid.The specified account or password is invalid.
    500InvalidAINode.NotFoundThe 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 timeSummary of changesOperation
    2023-11-07The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: DescribeType
    2023-09-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      delete Error Codes: 500
      Added Error Codes: 400
    2023-07-25The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DescribeType
    2023-07-20The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
      Added Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: NodeType