文档中心

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

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

2 规格配置相关接口

2.1 查询Region信息

获取可用区和地域信息。

2.1.1 使用描述

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

2.1.2 请求参数

无

2.1.3 返回数据

表2-1 RegionVO 数据结构

表2-2 ZoneVO 数据结构

2.1.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeRegions
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
     "Items": [
     {
         "RegionId": "paas-test",
         "RegionName": "中央集群",
         "ZoneList": [
         {
             "ZoneId": "zone-1",
             "ZoneName": "可用区 01"
         }
         ]
     }
     ]
}

2.2 查询CPU架构类型

获取 CPU 架构类型。

2.2.1 使用描述

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

2.2.2 请求参数

表2-3 Query 中的请求参数

2.2.3 返回数据

表2-4 SpecVO 数据结构

2.2.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeArchTypes?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
      "Items": [
      {
        "Text": "飞腾计算",
        "Value": "1"
      },
    {
          "Text": "X86 计算",
          "Value": "2"
      }
      ]
}

2.3 查询数据库引擎

获取数据库引擎。

2.3.1 使用描述

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

2.3.2 请求参数

表2-5 Query 中的请求参数

2.3.3 返回数据

表2-6 SpecVO 数据结构

2.3.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeEngines?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
      "Items": [
    {
          "Text": "达梦",
          "Value": "DM"
    },
    {
          "Text": "OceanBase",
          "Value": "OB"
      },
      {
        "Text": "MySQL",
        "Value": "MySQL"
    },
    {
        "Text": "PostgreSQL",
          "Value": "PG"
      },
      {
          "Text": "Polar",
        "Value": "polar"
    },
      {
          "Text": "QianBase",
          "Value": "qianbase"
      },
      {
          "Text": "Greenplum",
          "Value": "Greenplum"
      }
      ]
}

2.4 查询数据库系列

获取数据库系列。

2.4.1 使用描述

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

2.4.2 请求参数

表2-7 Query 中的请求参数

2.4.3 返回数据

表2-8 SpecVO 数据结构

2.4.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeCategory?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
      "Items": [
    {
        "Text": "标准版 (单机实例)",
        "Value": "Basic"
    },
    {
        "Text": "金融版（三节点实例）",
        "Value": "Financial"
    },
    {
        "Text": "高可用版（主备实例）",
        "Value": "HA"
      },
      {
          "Text": "只读版（只读实例）",
          "Value": "ReadOnly"
      }
    ]
}

2.5 查询数据库版本号

获取数据库版本号。

2.5.1 使用描述

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

2.5.2 请求参数

表2-9 Query 中的请求参数

2.5.3 返回数据

表2-10 SpecVO 数据结构

2.5.4 示例

1. 请求示例
GET https://{Endpoint}/rdb/v1.0/describeMajorVersion?RegionId=paas-test&Engine=MySQL
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
    "Items": [
    {
        "Text": "5.7",
        "Value": "5.7"
    },
    {
          "Text": "8.0",
          "Value": "8.0"
      }
      ]
}

2.6 查询可用规格

获取数据库可用规格。

2.6.1 使用描述

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

2.6.2 请求参数

表2-11 Query 中的请求参数

2.6.3 返回数据

表2-12 SpecVO 数据结构

2.6.4 示例

1. 请求示例
GET
https://{Endpoint}/rdb/v1.0/describeAvailableClasses?ArchType=1&MajorVersion=5.7&Engine=MySQL&RegionId=paas-dev&ZoneId=zone-1&Category=Basic
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
    "Items": [
      {
        "Text": "MySQL5.7 ｜2 核 4GB",
        "Value": "rdb.mysql.large"
    },
    {
          "Text": "MySQL5.7 ｜2 核 8GB",
        "Value": "rdb.mysql.large2"
      },
      {
        "Text": "MySQL5.7 ｜4 核 8GB",
        "Value": "rdb.mysql.xlarge"
      },
    {
        "Text": "MySQL5.7 ｜4 核 16GB",
        "Value": "rdb.mysql.xlarge2"
    },
      {
        "Text": "MySQL5.7 ｜8 核 16GB",
        "Value": "rdb.mysql.2xlarge"
      },
    {
        "Text": "MySQL5.7 ｜8 核 32GB",
          "Value": "rdb.mysql.2xlarge2"
      }
      ]
}

2.7 查询实例参数模板

获取实例参数模板，接口参数请参照附录 D 获取。

2.7.1 使用描述

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

2.7.2 请求参数

表2-13 Query 中的请求参数

2.7.3 返回数据

表2-14 DBParamGroupVO 数据结构

2.7.4 示例

1. 请求示例
GET
https://{Endpoint}/rdb/v1.0/describeParameterGroups?MajorVersion=5.7&Engine=MySQL&EngineVersion=MySQL&Category=Basic
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
    "RequestId": "1661436680498",
    "Items": [
      {
          "DBParamGroupId": "40000",
          "DBParamGroupName": "MySQL"
      },
      {
          "DBParamGroupId": "40000",
          "DBParamGroupName": "MySQL"
      }
      ]
}

意见反馈

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

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