文档

DescribeAvailableSpec - 查询集群变配可选配置

更新时间:

查询 OceanBase 集群变配页可选配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
UpgradeTypestring

变配类型。

枚举值:
  • downgradediskdowngradedisk
  • upgradenodenumupgradenodenum
  • downgradespecdowngradespec
  • upgradespecupgradespec
  • upgradediskupgradedisk
  • downgradenodenumdowngradenodenum
upgradespec
Specstring

节点规格。

oceanbase.cluster.cd8.xlarge

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

返回数据。

AvailableSpecificationsobject []

集群可选配置信息。

Specstring

传输实例的规格。

oceanbase.cluster.cd8.xlarge
InstanceClassstring

集群规格信息。

4C16GB
NodeNumarray

节点个数。

integer

节点个数。

3
DiskSizeRangeobject

存储大小。

Steplong

最小调整粒度。

5
Maxlong

最大值。

40000
Minlong

最小值。

1000
LogDiskSizeRangeobject

日志盘大小。

Steplong

最小调整粒度。

5
Maxlong

最大值。

4000
Minlong

最小值。

100
DiskTypesarray

存储类型列表信息。

string

存储类型。

cloud_essd_pl1

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "AvailableSpecifications": [
      {
        "Spec": "oceanbase.cluster.cd8.xlarge",
        "InstanceClass": "4C16GB",
        "NodeNum": [
          3
        ],
        "DiskSizeRange": {
          "Step": 5,
          "Max": 40000,
          "Min": 1000
        },
        "LogDiskSizeRange": {
          "Step": 5,
          "Max": 4000,
          "Min": 100
        },
        "DiskTypes": [
          "cloud_essd_pl1"
        ]
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)