All Products
Search

This Product

    ApsaraDB for OceanBase (Deprecated):DescribeInstances

    Document Center

    ApsaraDB for OceanBase (Deprecated):DescribeInstances

    Last Updated:Jun 12, 2026

    Mengkueri informasi daftar Kluster OceanBase.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    oceanbase:DescribeInstances

    list

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    No

    ID Kluster OceanBase.

    ob317v4uif****
    ResourceGroupId

    string

    No

    Informasi ID kelompok sumber daya. Jika tidak ditentukan, semua resource dikembalikan.

    group1
    PageSize

    integer

    No

    Jumlah baris per halaman untuk kueri terpaginasi.

    • Nilai maksimum: 100.

    • Nilai default: 10.

    10
    PageNumber

    integer

    No

    Nomor halaman untuk kueri terpaginasi.

    • Nilai awal: 1.

    • Nilai default: 1.

    1
    InstanceName

    string

    No

    Nama Kluster OceanBase. Panjang nama harus 1 hingga 20 karakter, termasuk huruf dan karakter Mandarin. Jika parameter ini tidak ditentukan, nilai default adalah InstanceId kluster.

    ob4prod
    SearchKey

    string

    No

    Melakukan pencarian fuzzy berdasarkan ID instans, nama instans, ID penyewa, dan nama penyewa.

    pay
    WithOBCloudInstances

    boolean

    No

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    Instances

    array<object>

    Daftar informasi Kluster OceanBase.

    array<object>

    Informasi Kluster OceanBase.

    VpcId

    string

    vpcId.

    vpc-8vb8qjrixzovjpy******
    CommodityCode

    string

    Kode komoditas Kluster OceanBase.

    • oceanbase_oceanbasepre_public_cn: Paket langganan situs Tiongkok untuk database cloud.

    • oceanbase_oceanbasepost_public_cn: Paket bayar sesuai pemakaian situs Tiongkok untuk database cloud.

    • oceanbase_obpre_public_intl: Paket langganan situs internasional untuk database cloud.

    • oceanbase_obpost_public_intl: Paket bayar sesuai pemakaian situs internasional untuk database cloud.

    oceanbase_oceanbasepost_public_cn
    ExpireTime

    string

    Pengatur waktu kedaluwarsa kluster (format UTC).

    Catatan

    Parameter ini hanya berlaku untuk instans dengan metode penagihan langganan.

    2021-10-17T16:00:00Z
    State

    string

    Status kluster.

    • ONLINE("online"): Berjalan.

    • PENDING_CREATE("pending_create"): Membuat.

    • ARREARS_CLOSED("arrears_closed"): Bayar sesuai pemakaian tertunggak dan ditutup.

    • PREPAID_EXPIRE_CLOSED("prepaid_expire_closed"): Langganan kedaluwarsa dan ditutup.

    • WHITE_LIST_MODIFYING("white_list_modifying"): Mengubah daftar putih.

    • SSL_MODIFYING("ssl_modifying"): Mengubah konfigurasi SSL.

    • PARAMETER_MODIFYING("parameter_modifying"): Mengubah parameter.

    • TENANT_CREATING("tenant_creating"): Membuat penyewa.

    • TENANT_SPEC_MODIFYING("tenant_spec_modifying"): Mengubah spesifikasi penyewa.

    • EXPANDING("expanding"): Menambah skala node.

    • REDUCING("reducing"): Mengurangi skala node.

    • ZONE_CHANGING("zone_changing"): Mengubah zona ketersediaan.

    • SPEC_UPGRADING("spec_upgrading"): Meningkatkan spesifikasi paket.

    • SPEC_DOWNGRADING("spec_downgrading"): Menurunkan spesifikasi paket.

    • DISK_UPGRADING("disk_upgrading"): Meningkatkan spesifikasi penyimpanan.

    • UPGRADING("upgrading"): Meningkatkan versi.

    • PENDING_DELETE("pending_delete"): Menghapus kluster.

    • DELETED("deleted"): Kluster dihapus.

    • ABNORMAL("abnormal"): Tidak normal.

    • OFFLINE("offline"): Offline.

    • STANDBY_CREATING("standby_creating"): Membuat kluster cadangan.

    • STANDBY_DELETING("standby_deleting"): Menghapus kluster cadangan.

    • SWITCHOVER_SWITCHING("switchover_switching"): Melakukan alih bencana utama/cadangan.

    • STANDBY_DISCONNECTING("standby_disconnecting"): Menguraikan keterkaitan database cadangan.

    • LOG_DISK_UPGRADING("log_disk_upgrading"): Meningkatkan skala disk log.

    • ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying"): Mengubah optimasi isolasi.

    • DISKTYPE_MODIFYING("disktype_modifying"): Mengubah tipe disk data.

    • PROXY_SERVICE_CREATING("proxy_service_creating"): Mengaktifkan layanan proxy.

    • PROXY_SERVICE_DELETING("proxy_service_deleting"): Menonaktifkan layanan proxy.

    • PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying"): Mengubah spesifikasi layanan proxy.

    • READONLY_ADD_NODE("readonly_add_node"): Menambahkan node baca-saja.

    • READONLY_REDUCE_NODE("readonly_reduce_node"): Menghapus node baca-saja.

    • READONLY_REDUCE_ZONE("readonly_reduce_zone"): Menghapus zona ketersediaan replika baca-saja.

    • READONLY_ADD_ZONE("readonly_add_zone"): Menambahkan zona ketersediaan replika baca-saja.

    • READONLY_UPGRADE_SPEC("readonly_upgrade_spec"): Meningkatkan spesifikasi replika baca-saja.

    • READONLY_UPGRADE_DISK("readonly_upgrade_disk"): Meningkatkan skala penyimpanan replika baca-saja.

    • READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec"): Menurunkan spesifikasi replika baca-saja.

    • READONLY_DOWNGRADE_DISK("readonly_downgrade_disk"): Mengurangi skala disk replika baca-saja.

    • CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica"): Membuat replika baca-saja penyewa.

    • DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica"): Menghapus replika baca-saja penyewa.

    • DISK_DOWNGRADING("disk_downgrading"): Mengurangi skala disk.

    • DEPLOY_MODE_MODIFYING("deploy_mode_modifying"): Mengalihkan mode penyebaran.

    Catatan

    Kluster umumnya berada dalam status berjalan (ONLINE).

    ONLINE
    InstanceClass

    string

    Informasi spesifikasi kluster.
    Paket yang saat ini didukung:

    • 4C16GB: 4 inti, 16 GB.

    • 8C32GB: 8 inti, 32 GB.

    • 14C70GB: 14 inti, 70 GB.

    • 24C120GB: 24 inti, 120 GB.

    • 30C180GB: 30 inti, 180 GB.

    • 62C400GB: 62 inti, 400 GB.

    • 104C600GB: 104 inti, 600 GB.

    • 16C70GB: 16 inti, 70 GB.

    • 32C160GB: 32 inti, 160 GB.

    • 64C380GB: 64 inti, 380 GB.

    • 20C32GB: 20 inti, 32 GB.

    • 40C64GB: 40 inti, 64 GB.

    • 16C32GB: 16 inti, 32 GB.

    • 32C70GB: 32 inti, 70 GB.

    • 64C180GB: 64 inti, 180 GB.

    • 32C180GB: 32 inti, 180 GB.

    • 64C400GB: 64 inti, 400 GB.

    14C70G
    CreateTime

    string

    Pengatur waktu pembuatan kluster, dalam UTC.

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

    string

    Mode replika data kluster. Terlepas dari apakah kluster disebarkan di zona tunggal, zona ganda, atau beberapa zona, nilai kembali dalam format n-n-n, di mana n mewakili jumlah node OBServer di setiap zona.

    1-1-1
    CpuArchitecture

    string

    Arsitektur CPU kluster.

    X86_64、 AARCH64
    MaintainTime

    string

    Jendela pemeliharaan harian kluster, dalam UTC.

    19:00Z-20:00Z
    DeployType

    string

    Tipe Penerapan kluster.

    • multiple: Multi-zona.

    • single: Zona tunggal.

    • dual: Zona ganda.

    multiple
    PayType

    string

    Metode penagihan Kluster OceanBase:

    • PREPAY: Langganan.

    • POSTPAY: Bayar sesuai pemakaian.

    PREPAY
    DiskSize

    integer

    Ukuran ruang penyimpanan, dalam GB.

    200
    DiskType

    string

    Tipe penyimpanan Penerapan kluster.

    cloud_essd_pl1
    InstanceId

    string

    ID Kluster OceanBase.

    ob317v4uif****
    ExpireSeconds

    integer

    Pengatur waktu yang berlalu sejak kluster kedaluwarsa, dalam detik.

    Catatan

    Untuk metode penagihan langganan, jika kluster belum kedaluwarsa, parameter ini menunjukkan sisa pengatur waktu penggunaan valid kluster. Setelah kluster kedaluwarsa, parameter ini menunjukkan pengatur waktu yang berlalu sejak kedaluwarsa.

    2606682
    Mem

    integer

    Ukuran memori instans, dalam GB.

    70
    EnableUpgradeNodes

    boolean

    Apakah penambahan node diizinkan.

    true
    Cpu

    integer

    Jumlah inti CPU kluster.

    14
    AvailableZones

    array

    Informasi zona ketersediaan tempat kluster disebarkan.

    string

    Informasi zona ketersediaan tempat kluster disebarkan.

    cn-hangzhou-i
    Version

    string

    Informasi versi OBServer.

    2.2.77
    InstanceName

    string

    Nama Kluster OceanBase. Panjang nama harus 1 hingga 20 karakter, termasuk huruf dan karakter Mandarin. Jika parameter ini tidak ditentukan, nilai default adalah InstanceId kluster.

    ob4test
    Series

    string

    Seri instans OceanBase.

    • normal (default): Jenis Penyimpanan Standar (cloud disk).

    • normal_ssd: Jenis Penyimpanan Standar (disk lokal).

    • history: Edisi Kluster Database Riwayat.

    • normal_kv: Kluster OBKV.

    • normal_hg: Kluster Xinchuang.

    NORMAL
    UsedDiskSize

    integer

    Ruang penyimpanan yang digunakan, dalam GB.

    20
    ResourceGroupId

    string

    ID kelompok sumber daya.

    group1
    Resource

    object

    Informasi Sumber daya kluster.

    Cpu

    object

    The information about the CPU resources of the cluster.

    TotalCpu

    number

    The total number of CPU cores of the cluster.

    14
    UsedCpu

    number

    The number of CPU cores used in the cluster.

    10
    UnitCpu

    number

    The number of CPU cores of each replica node in the cluster.

    10
    OriginalTotalCpu

    number

    The number of original CPU cores in the cluster.

    14
    Memory

    object

    The information about the memory resources of the cluster.

    TotalMemory

    number

    The total memory size of the cluster, in GB.

    70
    UsedMemory

    integer

    The size of used memory in the cluster, in GB.

    10
    UnitMemory

    integer

    The memory size of each replica node in the cluster, in GB.

    10
    OriginalTotalMemory

    number

    The original memory size of the cluster, in GB.

    72
    DiskSize

    object

    The information about the storage resources of the cluster.

    TotalDiskSize

    number

    The total storage space of the cluster, in GB.

    200
    UsedDiskSize

    integer

    The size of used storage space of the cluster, in GB.

    100
    UnitDiskSize

    number

    The storage space of each replica node in the cluster, in GB.

    200
    OriginalTotalDiskSize

    number

    The original size of the disk.

    200
    UnitCount

    integer

    The number of resource units in the cluster.

    1
    CapacityUnit

    object

    The information about capacity units.

    MaxCapacityUnit

    integer

    The maximum number of capacity units.

    4
    MinCapacityUnit

    integer

    The minimum number of capacity units.

    1
    UsedCapacityUnit

    integer

    The number of used capacity units.

    2
    InstanceType

    string

    Tipe instans.

    • cluster: Instans kluster.

    • mtenant: Instans penyewa mode MySQL.

    • mtenant_serverless: Instans arsitektur tanpa server mode MySQL.

    CLUSTER
    InstanceRole

    string

    Peran instans.

    NORMAL
    InTempCapacityStatus

    boolean

    Status kapasitas sementara.

    false
    DataDiskAutoScaleConfig

    object

    Konfigurasi penskalaan otomatis disk data.

    AutoScale

    boolean

    Specifies whether to enable the automatic scaling of the data disk.

    true
    Upperbound

    number

    The maximum space, in GB, to which the data disk can be scaled.

    16
    UpperThreshold

    number

    The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.

    80
    UpperMergeThreshold

    number

    The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for major compactions.

    90
    MaxDiskSize

    integer

    The maximum size of the disk, in GB.

    80000
    ScaleStepInNormal

    number

    The size of scaling step during daily use.

    50
    ScaleStepInMerge

    number

    The size of scaling step during a major compaction.

    100
    UpperScaleStrategy

    string

    The scale-out strategy. Valid values: RAW and PERCENTAGE.

    RAW
    EnableReadOnlyReplicaManagement

    boolean

    Apakah kluster mengizinkan pembelian replika baca-saja.

    yes
    SpecType

    string

    Tipe spesifikasi.

    dedicatedspec
    ObRpmVersion

    string

    Informasi versi RPM kluster.

    4.2.1.7-107030032024062709
    ReplicaMode

    string

    Mode replika kluster.

    3F、2F1A
    Migratable

    boolean

    MigrationInfo

    object

    Informasi migrasi pasar cloud.

    Migratable

    boolean

    CheckResult

    object

    Level

    string

    Code

    string

    CodeName

    string

    Module

    string

    ModuleName

    string

    SubModule

    string

    SubModuleName

    string

    Iops

    integer

    10000
    TotalCount

    integer

    Jumlah total Kluster OceanBase yang dikueri.

    2
    RequestId

    string

    ID permintaan.

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

    Contoh

    Respons sukses

    JSONformat

    {
  "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,
      "SpecType": "dedicatedspec",
      "ObRpmVersion": "4.2.1.7-107030032024062709",
      "ReplicaMode": "3F、2F1A",
      "Migratable": false,
      "MigrationInfo": {
        "Migratable": false,
        "CheckResult": {
          "Level": "",
          "Code": "",
          "CodeName": "",
          "Module": "",
          "ModuleName": "",
          "SubModule": "",
          "SubModuleName": ""
        }
      },
      "Iops": 10000
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.