All Products
Search
Document Center

ApsaraDB for OceanBase:CreateDatabase

Last Updated:Dec 02, 2024

You can call this operation to create a database in a tenant.

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.

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
oceanbase:CreateDatabasecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DatabaseNamestringYes

Alibaba Cloud CLI

sms_pre
TenantIdstringYes

The name of the database.
You cannot use reserved keywords, such as test and mysql.

ob2mr3oae0****
EncodingstringYes

The ID of the tenant.

utf8mb4
CollationstringNo

The encoding standard of the database. For more information, see the Charset field returned by the DescribeCharset operation.

utf8mb4_general_ci
InstanceIdstringNo

The collation.

ob317v4uif****
ClientTokenstringNo

The name of the database.

123e4567-e89b-12d3-a456-426655440000
DescriptionstringNo

The operation that you want to perform.
Set the value to CreateDatabase.

this is a test database

Response parameters

ParameterTypeDescriptionExample
object

Example 1

RequestIdstring
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
DatabaseNamestring

CreateDatabase

sms_pre

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "DatabaseName": "sms_pre"
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
2023-07-04The Error code has changedView Change Details
2022-09-28The Error code has changed. The request parameters of the API has changedView Change Details