文档中心

云数据库服务RDB API参考手册

最近更新时间：2023-04-16 17:00:00

4 数据库相关接口

4.1 创建数据库

创建数据库。

4.1.1 使用描述

Content-Type: application/json
POST https://{Endpoint}/rdb/v1.0/createDatabase

4.1.2 请求参数

表4-1 Body 中的请求参数

4.1.3 返回数据

4.1.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/createDatabase
{
      "InstanceId": "mysql-d8b640278c19",
    "Engine": "MySQL",
      "DBName": "test",
      "DBDescription": "测试库",
    "CharacterSetName": "utf8"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}

4.2 查询数据库列表

获取数据库列表。

4.2.1 使用描述

GET https://{Endpoint}/rdb/v1.0/describeDatabases

4.2.2 请求参数

表4-2 Query 中的请求参数

4.2.3 返回数据

表4-3 DBVO 数据结构

4.2.4 示例

1. 请求示例
GET
https://{Endpoint}/rdb/v1.0/describeDatabases?PageNumber=1&PageSize=10&InstanceId=mysql-d8b640278c19&Engine=MySQL
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
    "TotalCount": 2,
    "PageNumber": 1,
      "PageSize": 10,
        "Items": [
        {
              "InstanceId": "mysql-d8b640278c19",
            "DBName": "hcmp",
              "DBDescription": "测试库",
              "CharacterSetName": "gbk"
          },
          {
            "InstanceId": "mysql-d8b640278c19",
            "DBName": "test_db",
              "DBDescription": "test",
              "CharacterSetName": "utf8mb4"
          }
          ]
}

4.3 删除数据库

删除数据库。

4.3.1 使用描述

Content-Type: application/json
DELETE https://{Endpoint}/rdb/v1.0/dropDatabase

4.3.2 请求参数

表4-4 Body 中的请求参数

4.3.3 返回数据

4.3.4 示例

1. 请求示例
DELETE
https://{Endpoint}/rdb/v1.0/dropDatabase
{
      "InstanceId": "mysql-d8b640278c19",
    "Engine": "MySQL",
    "DBName": "test_db"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}