DescribeAvailableSpec - 查询集群变配可选配置_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeAvailableSpec	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
UpgradeType	string	是	变配类型。枚举值： downgradedisk：downgradedisk。 upgradenodenum：upgradenodenum。 downgradespec：downgradespec。 upgradespec：upgradespec。 upgradedisk：upgradedisk。 downgradenodenum：downgradenodenum。	upgradespec
Spec	string	否	节点规格。	oceanbase.cluster.cd8.xlarge

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	返回数据。
AvailableSpecifications	array<object>	集群可选配置信息。
AvailableSpecifications	object	集群可选配置信息列表。
Spec	string	传输实例的规格。	oceanbase.cluster.cd8.xlarge
InstanceClass	string	集群规格信息。	4C16GB
NodeNum	array	节点个数。
NodeNum	integer	节点个数。	3
DiskSizeRange	object	存储大小。
Step	long	最小调整粒度。	5
Max	long	最大值。	40000
Min	long	最小值。	1000
LogDiskSizeRange	object	日志盘大小。
Step	long	最小调整粒度。	5
Max	long	最大值。	4000
Min	long	最小值。	100
DiskTypes	array	存储类型列表信息。
DiskTypes	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-26	OpenAPI 返回结构发生变更	查看变更详情
2023-11-07	OpenAPI 返回结构发生变更	查看变更详情