文档中心

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

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

3 实例相关接口

3.1 创建RDB实例

创建 RDB 实例。

3.1.1 使用描述

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

3.1.2 请求参数

表3-1 Body 中的请求参数

3.1.3 返回数据

3.1.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/createDBInstance
{
     "ArchType": "1",
     "DBInstanceStorage": 5,
     "DBIsIgnoreCase": "0",
     "DBParamGroupId": "40000",
     "Engine": "MySQL",
     "DBInstanceClass": "rdb.mysql.large",
     "InstanceName": "cecloud-rdb-7777",
     "MajorVersion": "5.7",
     "RegionId": "paas-test
     "Amount": "1",
     "PasswordSetting": "0",
     "SubnetId": "snet-kwm15022n7",
     "TsEncrypt": true,
     "UpgradeKernelVersion": 0,
     "VpcId": "vpc-s8p05m46kb",
     "ZoneId": "zone-1",
      "Category":"Basic"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
    "InstanceId": "mysql-38b5b5aaeb35"
}

3.2 查询RDB实例列表

获取实例列表。

3.2.1 使用描述

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

3.2.2 请求参数

表3-2 Query 中的请求参数

3.2.3 返回数据

表3-3 InstanceVO 数据结构

3.2.4 示例

3.3 查询RDB实例详情

获取实例详情。

3.3.1 使用描述

GET https://{Endpoint}/rdb/v1.0/describeDBInstanceAttribute/{InstanceId}

3.3.2 请求参数

表3-4 Path 中的请求参数

3.3.3 返回数据

3.3.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeDBInstanceAttribute/mysql-7cd78ae0488a
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",
      "RegionId": "paas-dev",
      "ZoneId": "zone-1",
      "InstanceName": "cecloud-rdb-8888",
      "InstanceId": "mysql-7cd78ae0488a",
      "VpcId": "vpc-s8p05m46kb",
      "VpcName": "vpc-123453",
      "DBInstanceClass": "rdb.mysql.large",
      "Engine": "MySQL",
      "DBParamGroupId": "40000",
      "DBInstanceStorage": "5",
      "DBInstanceStorageType": "local_ssd",
      "Category": "Basic",
      "MajorVersion": "5.7",
      "SubnetId": "snet-kwm15022n7",
      "Status": "1",
      "CreatedAt": "2022-08-25T03:12:16Z",
      "NetworkAddress": "mysql-7cd78ae0488a-proxy.zone-01.paas-dev.cecloudcs.com",
      "NetworkPort": "3331",
      "Cpu": 2,
      "Memory": 4096,
      "MaxIops": 600,
      "MaxlinkNum": 300,
    "SpecGroup": "共享型（通用型）",
    "MaintainTimeStart": "02:00",
      "MaintainTimeEnd": "06:00",
      "ReadOnlyInstance": 0,
      "TdeKey": null,
      "TsEncrypt": true,
      "Series": "MySQL5.7",
      "NodeNumber": null
}

3.4 释放RDB实例

删除 RDB 实例。

3.4.1 使用描述

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

3.4.2 请求参数

表3-5 Path 中的请求参数

3.4.3 返回数据

3.4.4 示例

1. 请求示例
DELETE https://{Endpoint}/rdb/v1.0/deleteDBInstance/mysql-7cd78ae0488a
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}

3.5 重启RDB实例

重启 RDB 实例。

3.5.1 使用描述

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

3.5.2 请求参数

表3-6 Path 中的请求参数

3.5.3 返回数据

3.5.4 示例

1. 请求示例
POST https://{Endpoint}/rdb/v1.0/restartDBInstance/mysql-7cd78ae0488a
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}

3.6 升配RDB实例

升配 RDB 实例，Polar 数据库引擎不支持升配。

3.6.1 使用描述

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

3.6.2 请求参数

表3-7 Body 中的请求参数

3.6.3 返回数据

3.6.4 示例

1. 请求示例
POST https://{Endpoint}/rdb/v1.0/restartDBInstance
{
    "DBInstanceStorage": 50,
    "DBInstanceClass": "rdb.mysql.xlarge",
    "InstanceId": "mysql-d8b640278c19"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服