文档

DescribeInstances - 查询集群列表

更新时间:

查询 OceanBase 集群列表信息。

调试

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

授权信息

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

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
ResourceGroupIdstring

资源组 ID 信息。 如果不填写,返回全部资源。

group1
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:100。
  • 默认值:10。
10
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1
InstanceNamestring

OceanBase 集群名称。 长度为 1~20 个英文或中文字符。 如未指定该参数,默认值为集群的 InstanceId。

ob4prod
SearchKeystring

根据实例 ID、实例名称、租户 ID 和租户名称进行模糊搜索。

pay

返回参数

名称类型描述示例值
object

请求的返回结果。

Instancesobject []

OceanBase 集群信息列表。

VpcIdstring

vpcId

vpc-8vb8qjrixzovjpy******
CommodityCodestring

OceanBase 集群的产品码。

  • oceanbase_oceanbasepre_public_cn:中国站云数据库包年包月套餐。
  • oceanbase_oceanbasepost_public_cn:中国站云数据库按小时付费套餐。
  • oceanbase_obpre_public_intl:国际站云数据库包年包月套餐。
  • oceanbase_obpost_public_intl:国际站云数据库按小时付费套餐。
oceanbase_oceanbasepost_public_cn
ExpireTimestring

集群过期时间(UTC 格式)。

说明 该参数仅适用于包年包月付费方式的实例。
2021-10-17T16:00:00Z
Statestring

集群状态。

  • ONLINE("online") : 运行中。
  • PENDING_CREATE("pending_create"): 创建中。
  • ARREARS_CLOSED("arrears_closed"):后付费逾期欠费关闭。
  • PREPAID_EXPIRE_CLOSED("prepaid_expire_closed"):预付费到期关闭。
  • WHITE_LIST_MODIFYING("white_list_modifying"):白名单修改中。
  • SSL_MODIFYING("ssl_modifying"):ssl 配置变更中。
  • PARAMETER_MODIFYING("parameter_modifying"):参数修改中。
  • TENANT_CREATING("tenant_creating"):租户创建中。
  • TENANT_SPEC_MODIFYING("tenant_spec_modifying"):租户规格修改中。
  • EXPANDING("expanding"):节点扩容中。
  • REDUCING("reducing"):节点缩容中。
  • ZONE_CHANGING("zone_changing"):可用区变更中。
  • SPEC_UPGRADING("spec_upgrading"):套餐规格扩容中。
  • SPEC_DOWNGRADING("spec_downgrading"):套餐规格缩容中。
  • DISK_UPGRADING("disk_upgrading"):存储规格扩容中。
  • UPGRADING("upgrading"):版本升级中。
  • PENDING_DELETE("pending_delete"):集群删除中。
  • DELETED("deleted"):集群已删除。
  • ABNORMAL("abnormal"):异常。
  • OFFLINE("offline"):下线。
  • STANDBY_CREATING("standby_creating"):备集群创建中。
  • STANDBY_DELETING("standby_deleting"):备集群删除中。
  • SWITCHOVER_SWITCHING("switchover_switching"):主备切换中。
  • STANDBY_DISCONNECTING("standby_disconnecting"):备库解耦中。
  • LOG_DISK_UPGRADING("log_disk_upgrading"):日志盘扩容中。
  • ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying"):隔离优化变更中。
  • DISKTYPE_MODIFYING("disktype_modifying"):数据盘类型变更中。
  • PROXY_SERVICE_CREATING("proxy_service_creating"):代理服务开通中。
  • PROXY_SERVICE_DELETING("proxy_service_deleting"):代理服务关闭中。
  • PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying"):代理服务规格修改中。
  • READONLY_ADD_NODE("readonly_add_node"):新增只读节点中。
  • READONLY_REDUCE_NODE("readonly_reduce_node"):删除只读节点中。
  • READONLY_REDUCE_ZONE("readonly_reduce_zone"):删除只读副本可用区中。
  • READONLY_ADD_ZONE("readonly_add_zone"):新增只读副本可用区。
  • READONLY_UPGRADE_SPEC("readonly_upgrade_spec"):只读副本规格升配中。
  • READONLY_UPGRADE_DISK("readonly_upgrade_disk"):只读副本存储扩容中。
  • READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec"):只读副本规格降配中。
  • READONLY_DOWNGRADE_DISK("readonly_downgrade_disk"):只读副本磁盘缩容中。
  • CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica"):租户创建只读副本中。
  • DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica"):租户删除只读副本中。
  • DISK_DOWNGRADING("disk_downgrading"):磁盘缩容中。
  • DEPLOY_MODE_MODIFYING("deploy_mode_modifying"):部署模式切换中。
说明 集群一般为运行中的状态(ONLINE)。
ONLINE
InstanceClassstring

集群规格信息。
当前支持以下套餐:

  • 4C16GB:4 核 16GB。
  • 8C32GB:8 核 32GB。
  • 14C70GB:14 核 70GB。
  • 24C120GB:24 核 120GB。
  • 30C180GB:30 核 180GB。
  • 62C400GB:62 核 400GB。
  • 104C600GB:104 核 600GB。
  • 16C70GB:16 核 70GB。
  • 32C160GB:32 核 160GB。
  • 64C380GB:64 核 380GB。
  • 20C32GB:20 核 32GB。
  • 40C64GB:40 核 64GB。
  • 16C32GB:16 核 32GB。
  • 32C70GB:32 核 70GB。
  • 64C180GB:64 核 180GB。
  • 32C180GB:32 核 180GB。
  • 64C400GB:64 核 400GB。
14C70G
CreateTimestring

集群的创建时间,UTC 时间。

2021-10-19T07:13:41Z
DeployModestring

集群的数据副本模式。 无论集群为单机房、双机房或多机房部署,返回值均为 n-n-n,其中 n 为各机房的 OBServer 节点数。

1-1-1
CpuArchitecturestring

集群的 CPU 架构

X86_64、 AARCH64
MaintainTimestring

集群的每天例行维护时间,UTC 时间。

19:00Z-20:00Z
DeployTypestring

集群的部署类型。

  • multiple:多机房;
  • single:单机房;
  • dual:双机房。
multiple
PayTypestring

OceanBase 集群的付费类型:

  • PREPAY:预付费;
  • POSTPAY:按量付费。
PREPAY
DiskSizestring

存储空间大小,单位 GB。

200
DiskTypestring

集群部署的存储类型。

cloud_essd_pl1
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
ExpireSecondsinteger

集群已过期时间,单位:秒(s)。

说明 包年包月付费模式下,若集群还未到期,该参数表示集群剩余有效使用时间。集群过期后,该参数表示集群已过期时间。
2606682
Memlong

实例的内存大小,单位 GB。

70
EnableUpgradeNodesboolean

是否允许新增节点。

true
Cpuinteger

集群的 CPU 核数。

14
AvailableZonesarray

集群部署所在的可用区信息。

string

集群部署所在的可用区信息。

cn-hangzhou-i
Versionstring

OBServer 版本信息。

2.2.77
InstanceNamestring

OceanBase 集群名称。 长度为 1~20 个英文或中文字符。如果没有指定该参数,默认值为集群的 InstanceId。

ob4test
Seriesstring

Oceanbase 实例的系列。

  • normal(默认):标准集群版(云盘)。
  • normal_ssd:标准集群版(本地盘)。
  • history:历史库集群版。
  • normal_kv:obkv 集群。
  • normal_hg:信创集群。
NORMAL
UsedDiskSizelong

已使用的存储空间,单位 GB。

20
ResourceGroupIdstring

资源组 ID 信息。

group1
Resourceobject

集群的资源信息。

Cpuobject

集群的 CPU 资源信息。

TotalCpudouble

集群总 CPU,单位:核数。

14
UsedCpudouble

集群已使用的 CPU,单位:核数。

10
UnitCpudouble

集群中每个副本节点的 CPU,单位:核数。

10
OriginalTotalCpudouble

原始 CPU。

14
Memoryobject

集群的内存资源信息。

TotalMemorydouble

集群总内存,单位:GB。

70
UsedMemorylong

集群已使用的内存,单位:GB。

10
UnitMemorylong

集群中每个副本的内存,单位:GB。

10
OriginalTotalMemorydouble

原始内存。

72
DiskSizeobject

集群的存储资源信息。

TotalDiskSizedouble

集群总存储空间,单位:GB。

200
UsedDiskSizelong

集群已使用的存储空间,单位:GB。

100
UnitDiskSizedouble

集群每个副本的存储空间,单位:GB。

200
OriginalTotalDiskSizedouble

原始磁盘。

200
UnitCountlong

集群的资源 Unit 数量。

1
CapacityUnitobject

容量单元。

MaxCapacityUnitinteger

最大容量单元。

4
MinCapacityUnitinteger

最小容量单元。

1
UsedCapacityUnitinteger

已用容量单位。

2
InstanceTypestring

实例类型。

  • cluster:集群实例。
  • mtenant:MySQL 模式的租户实例。
  • mtenant_serverless:MySQL 模式的 Serverless 实例。
CLUSTER
InstanceRolestring

实例角色。

NORMAL
InTempCapacityStatusboolean

临时容量状态。

false
DataDiskAutoScaleConfigobject

数据盘自动协调配置。

AutoScaleboolean

是否开启。

true
Upperbounddouble

扩容上限。

16
UpperThresholddouble

日常扩容阈值。

80
UpperMergeThresholddouble

合并扩容阈值。

90
MaxDiskSizelong

磁盘最大值。

80000
ScaleStepInNormaldouble

日常扩容步长。

50
ScaleStepInMergedouble

合并扩容步长。

100
UpperScaleStrategystring

扩容策略(RAW/PERCENTAGE)

RAW
EnableReadOnlyReplicaManagementboolean

该集群是否允许购买只读副本。

yes
TotalCountinteger

所查询的 OceanBase 集群个数。

2
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "VpcId": "vpc-8vb8qjrixzovjpy******",
      "CommodityCode": "oceanbase_oceanbasepost_public_cn",
      "ExpireTime": "2021-10-17T16:00:00Z",
      "State": "ONLINE",
      "InstanceClass": "14C70G",
      "CreateTime": "2021-10-19T07:13:41Z",
      "DeployMode": "1-1-1",
      "CpuArchitecture": "X86_64、 AARCH64",
      "MaintainTime": "19:00Z-20:00Z",
      "DeployType": "multiple",
      "PayType": "PREPAY",
      "DiskSize": "200",
      "DiskType": "cloud_essd_pl1",
      "InstanceId": "ob317v4uif****",
      "ExpireSeconds": 2606682,
      "Mem": 70,
      "EnableUpgradeNodes": true,
      "Cpu": 14,
      "AvailableZones": [
        "cn-hangzhou-i"
      ],
      "Version": "2.2.77",
      "InstanceName": "ob4test",
      "Series": "NORMAL",
      "UsedDiskSize": 20,
      "ResourceGroupId": "group1",
      "Resource": {
        "Cpu": {
          "TotalCpu": 14,
          "UsedCpu": 10,
          "UnitCpu": 10,
          "OriginalTotalCpu": 14
        },
        "Memory": {
          "TotalMemory": 70,
          "UsedMemory": 10,
          "UnitMemory": 10,
          "OriginalTotalMemory": 72
        },
        "DiskSize": {
          "TotalDiskSize": 200,
          "UsedDiskSize": 100,
          "UnitDiskSize": 200,
          "OriginalTotalDiskSize": 200
        },
        "UnitCount": 1,
        "CapacityUnit": {
          "MaxCapacityUnit": 4,
          "MinCapacityUnit": 1,
          "UsedCapacityUnit": 2
        }
      },
      "InstanceType": "CLUSTER",
      "InstanceRole": "NORMAL",
      "InTempCapacityStatus": false,
      "DataDiskAutoScaleConfig": {
        "AutoScale": true,
        "Upperbound": 16,
        "UpperThreshold": 80,
        "UpperMergeThreshold": 90,
        "MaxDiskSize": 80000,
        "ScaleStepInNormal": 50,
        "ScaleStepInMerge": 100,
        "UpperScaleStrategy": "RAW"
      },
      "EnableReadOnlyReplicaManagement": true
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-02-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-01-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)