All Products
Search
Document Center

PolarDB:CreateDatabase

Last Updated:Nov 07, 2023

Creates a database for a PolarDB cluster.

Operation Description

Before you call this operation, make sure that the following requirements are met:

  • The cluster is in the Running state.
  • The cluster is unlocked.

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.

debugging

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of cluster.

pc-**************
DBNamestringYes

The name of the database. The name must meet the following requirements:

  • The name can contain lowercase letters, digits, hyphens (-), and underscores (_).
  • The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 1 to 64 characters in length.
Note Do not use reserved words as database names, such as test or mysql.
testDB
CharacterSetNamestringYes

The character set that is used by the cluster. For more information, see Character set tables.

utf8
DBDescriptionstringNo

The description of the database. The description must meet the following requirements:

  • It cannot start with http:// or https://.
  • It must be 2 to 256 characters in length.
Note This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.
testdesc
AccountNamestringNo

The name of the account that is authorized to access the database. You can call the DescribeAccounts operation to query account information.

Note
  • You can specify only a standard account. By default, privileged accounts have all permissions on all databases. You do not need to grant privileged accounts the permissions to access the database.
  • This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.
  • testacc
    AccountPrivilegestringNo

    The permissions that are granted to the account. Valid values:

    • ReadWrite: read and write permissions.
    • ReadOnly: read-only permissions.
    • DMLOnly: the permissions to execute only DML statements.
    • DDLOnly: the permissions to execute only DDL statements.
    • ReadIndex: the read-only and index permissions.

    If you leave this parameter empty, the default value ReadWrite is used.

    Note
  • This parameter is valid only if you specify AccountName.
  • This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters.
  • This parameter is optional for PolarDB for MySQL clusters.
  • ReadWrite
    CollatestringNo

    The language that indicates the collation of the databases that are created.

    Note
  • The language must be compatible with the character set that is specified by CharacterSetName.
  • This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is not supported by PolarDB for MySQL clusters.
  • To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose Settings and Management > Databases. Then, click Create Database.

    C
    CtypestringNo

    The language that indicates the character type of the database.

    Note
  • The language must be compatible with the character set that is specified by CharacterSetName.
  • The value that you specify must be the same as the value of Collate.
  • This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.
  • To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose Settings and Management > Databases. Then, click Create Database.

    C

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    93E98F25-BE02-40DA-83E3-F77F8D******

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "93E98F25-BE02-40DA-83E3-F77F8D******"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBName.MalformedThe specified parameter DBName is not valid.The format of the specified database name is invalid.
    400Database.AddErrorInstance %s add database minidoc errorFailed to add database minidoc to cluster %s.
    400InvalidDBDescription.MalformedThe specified parameter DBDescription is not valid.The specified DBDescription parameter is invalid.
    400InvalidAccountPrivilege.MalformedThe specified parameter AccountPrivilege is not valid.The specified AccountPrivilege parameter is invalid.
    400InvalidAccountName.MalformedThe specified parameter AccountName is not valid.The specified AccountName parameter is invalid.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      Error Codes 404 change