DescribeInstance - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud Documentation Center

Mengkueri detail 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:DescribeInstance

get

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID kluster OceanBase.	ob317v4uif****
PageNumber	integer	No	Nomor halaman untuk kueri terpaginasi. Nilai awal: 1. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object	Hasil respons dari permintaan.
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	Informasi kluster OceanBase.
InstanceId	string	ID kluster OceanBase.	ob317v4uif****
InstanceName	string	Nama kluster OceanBase.	ob4test
InstanceClass	string	Informasi spesifikasi kluster. Paket yang saat ini didukung: 4C16GB: 4 core, 16GB. 8C32GB: 8 core, 32GB. 14C70GB: 14 core, 70GB. 24C120GB: 24 core, 120GB. 30C180GB: 30 core, 180GB. 62C400GB: 62 core, 400GB. 104C600GB: 104 core, 600GB. 16C70GB: 16 core, 70GB. 32C160GB: 32 core, 160GB. 64C380GB: 64 core, 380GB. 20C32GB: 20 core, 32GB. 40C64GB: 40 core, 64GB. 16C32GB: 16 core, 32GB. 32C70GB: 32 core, 70GB. 64C180GB: 64 core, 180GB. 32C180GB: 32 core, 180GB. 64C400GB: 64 core, 400GB.	14C70G
Series	string	Seri instans. normal (default): Jenis Penyimpanan Standar (cloud disk). normal_ssd: Jenis Penyimpanan Standar (local disk). history: Edisi Kluster Database Riwayat. normal_kv: Kluster OBKV. normal_hg: Kluster Xinchuang.	Normal
PayType	string	Tipe pembayaran kluster OceanBase. PREPAY: Langganan. POSTPAY: Bayar sesuai pemakaian.	PREPAY
CreateTime	string	Pengatur waktu pembuatan kluster (waktu UTC).	2021-10-19T07:13:41Z
ExpireTime	string	Pengatur waktu kedaluwarsa kluster (format UTC).	2021-10-17T16:00:00Z
Version	string	Informasi versi OBServer.	2.2.77
DeployType	string	Tipe penyebaran kluster. multiple: Multi-zona. single: Zona tunggal. dual: Dual-zona.	multiple
DeployMode	string	Mode replika data kluster. Single-zone: n. Dual-zone: n-n. Multi-zone: n-n-n. Catatan Di mana n adalah jumlah node OBServer di setiap zona.	1-1-1
DiskType	string	Tipe penyimpanan untuk penerapan kluster. Nilai default adalah cloud_essd_pl1: ESSD cloud disk.	cloud_essd_pl1
MaintainTime	string	Pengatur waktu pemeliharaan rutin harian kluster, dalam waktu UTC.	19:00Z-20:00Z
DataMergeTime	string	Pengatur waktu penggabungan data kluster.	02:00
AutoRenewal	boolean	Apakah perpanjangan otomatis diaktifkan. Parameter ini hanya berlaku untuk kluster langganan (PREPAY).	true
IsTrustEcs	boolean	Apakah ECS tepercaya digunakan.	true
Status	string	Status kluster. PENDING_CREATE: Membuat. ONLINE: Berjalan. TENANT_CREATING: Membuat penyewa. TENANT_SPEC_MODIFYING: Mengubah spesifikasi penyewa. EXPANDING: Penskalaan keluar node. REDUCING: Penskalaan masuk node. SPEC_UPGRADING: Meningkatkan spesifikasi. DISK_UPGRADING: Meningkatkan spesifikasi penyimpanan. WHITE_LIST_MODIFYING: Mengubah daftar putih. PARAMETER_MODIFYING: Mengubah parameter. SSL_MODIFYING: Mengubah SSL. PREPAID_EXPIRE_CLOSED: Kluster langganan jatuh tempo. ARREARS_CLOSED: Kluster bayar sesuai pemakaian jatuh tempo. PENDING_DELETE: Menghapus. Kluster umumnya berada dalam status berjalan (ONLINE).	ONLINE
Resource	object	Informasi resource kluster.
Cpu	object	The information about the CPU resources of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of CPU cores used in the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The number of original CPU cores in the cluster.	14
Memory	object	The information about the memory resources of the cluster.
TotalMemory	integer	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	integer	The original memory size of the cluster, in GB.	72
DiskSize	object	The information about the storage resources of the cluster.
TotalDiskSize	integer	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	integer	The storage space of each replica node in the cluster, in GB.	200
DataUsedSize	number	The size of the data disk, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the OBServer node.
	string	The maximum disk usage of the OBServer node.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original size of the disk.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The information about the log disk space of the cluster.
TotalDiskSize	integer	The total log disk space of the cluster, in GB.	400
UnitDiskSize	integer	The log disk space of each replica node in the cluster. Unit: GB.	200
LogAssignedSize	string	The allocated disk space for log storage, in GB.	0.0
MaxLogAssignedObServer	array	The maximum storage space allocated for.
	string	The list of the OBServer nodes that are allocated the maximum log storage space.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of space allocated for log storage.	6.68
OriginalTotalDiskSize	integer	The original size of the disk.	200
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	string	The number of used capacity units.	2
AutoUpgradeObVersion	boolean	Apakah peningkatan versi OBServer otomatis diaktifkan.	true
ObRpmVersion	string	Informasi versi OBServer terperinci.	2.2.77-20210526202046
IsLatestObVersion	boolean	Apakah versi OBServer adalah versi terbaru.	true
AvailableZones	array	Daftar zona yang tersedia.
	string	Daftar zona yang tersedia.	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	Apakah peningkatan spesifikasi disk log diizinkan.	false
Zones	array	ID zona tempat instans berada. Untuk detail lebih lanjut, lihat DescribeZones untuk mendapatkan daftar zona yang tersedia.
	string	ID zona tempat instans berada. Untuk detail lebih lanjut, lihat DescribeZones untuk mendapatkan daftar zona yang tersedia.	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	Peran instans.	NORMAL
NodeNum	string	Jumlah node di kluster. Jika mode penyebaran adalah n-n-n, jumlah node adalah n × 3.	6
ReplicaMode	string	Jumlah replika berfitur lengkap. Nilai kembali hanya berisi 3 dan 2. 3: Menunjukkan 3 replika berfitur lengkap. 2: Menunjukkan 2 replika berfitur lengkap. Penerapan tiga zona hanya mendukung 3 replika berfitur lengkap, penerapan dual-zona hanya mendukung 2 replika berfitur lengkap, dan penerapan zona tunggal mendukung 2 atau 3 replika berfitur lengkap.	2
IsolationOptimization	boolean	Apakah Cgroup diaktifkan.	false
EnableIsolationOptimization	boolean	Apakah optimasi isolasi diizinkan.	false
InTempCapacityStatus	boolean	Status kapasitas sementara.	false
DataDiskAutoScale	boolean	Apakah penskalaan disk data otomatis diaktifkan. Catatan Parameter ini telah ditinggalkan.	-
TenantCreatable	object	Ketersediaan pembuatan penyewa.
EnableCreateTenant	boolean	Specifies whether a tenant can be created.	true
DisableCreateTenantReason	string	The reason why you cannot create a tenant in the cluster.	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	Konfigurasi penskalaan otomatis disk data.
AutoScale	boolean	Specifies whether to enable the automatic scaling of the data disk.	true
Upperbound	integer	The maximum space, in GB, to which the data disk can be scaled.	16
UpperThreshold	integer	The maximum usage of the data disk, in percentage, that triggers the scaling of the data disk for daily use.	80
UpperMergeThreshold	integer	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	integer	The size of scaling step during daily use.	50
ScaleStepInMerge	integer	The size of scaling step during a major compaction.	100
UpperScaleStrategy	string	The scale-out strategy. Valid values: RAW and PERCENTAGE.	RAW
UpperScaleStep	string	The step size of the scale-out.	5
EnableProxyService	boolean	Apakah layanan proxy diaktifkan. true false.	true
ProxyServiceStatus	string	Status layanan proxy.	ONLINE
ProxyClusterId	string	ID kluster proxy. Catatan Parameter ini hanya disertakan ketika EnableProxyService adalah true.	proxy-56****a6tg2o
CpuArchitecture	string	Arsitektur CPU kluster.	X86
ReadOnlyResource	object	Informasi resource kluster.
Cpu	object	The information about the CPU resources of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of CPU cores used by the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The number of original CPU cores in the cluster.	14
Memory	object	The information about the memory resources of the cluster.
TotalMemory	integer	The total memory size of the cluster, in GB.	70
UsedMemory	integer	The size of memory used by the cluster, in GB.	10
UnitMemory	integer	The memory size of each replica node in the cluster, in GB.	10
OriginalTotalMemory	integer	The original memory size of the cluster.	72
DiskSize	object	The information about the storage resources of the cluster.
TotalDiskSize	integer	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	integer	The storage space of each replica node in the cluster, in GB.	200
DataUsedSize	number	The size of the data disk, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the OBServer node.
	string	The maximum disk usage of the OBServer node.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original size of the disk.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The information about the log disk space of the cluster.
TotalDiskSize	integer	The information about the log disk space of the cluster.	400
UnitDiskSize	integer	The log disk space of each replica node in the cluster, in GB.	200
LogAssignedSize	string	The allocated disk space for log storage, in GB.	0.0
MaxLogAssignedObServer	array	The maximum storage space allocated for.
	string	The list of the OBServer nodes that are allocated the maximum log storage space.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of space allocated for log storage.	6.68
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	string	The number of used capacity units.	2
UnitSpec	string	Spesifikasi unit layanan proxy.	2C4G
SharedUnitNumLimit	integer	Batas atas jumlah unit untuk layanan proxy mode bersama.	3
ExclusiveUnitNumLimit	integer	Batas atas jumlah unit untuk layanan proxy mode eksklusif.	1
EnableReadOnlyReplica	boolean	Apakah replika baca-saja didukung.	true
EnableReadOnlyReplicaManagement	boolean	Apakah kluster mengizinkan pembelian replika baca-saja.	false
PrimaryInstance	string	ID instans utama.	ob3h8ytroxxxxx
PrimaryRegion	string	Wilayah instans utama.	cn-hangzhou
SpecType	string	Tipe spesifikasi.	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	Apakah modifikasi koneksi jaringan publik maksimum diizinkan.	false
AllowCreateProxySqlFirewallRule	boolean	Apakah firewall SQL ODP diizinkan.	false
Iops	integer		10000

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Normal",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "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,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68",
        "OriginalTotalDiskSize": 200
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": "6",
    "ReplicaMode": "2",
    "IsolationOptimization": false,
    "EnableIsolationOptimization": false,
    "InTempCapacityStatus": false,
    "DataDiskAutoScale": true,
    "TenantCreatable": {
      "EnableCreateTenant": true,
      "DisableCreateTenantReason": "CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT"
    },
    "DataDiskAutoScaleConfig": {
      "AutoScale": true,
      "Upperbound": 16,
      "UpperThreshold": 80,
      "UpperMergeThreshold": 90,
      "MaxDiskSize": 80000,
      "ScaleStepInNormal": 50,
      "ScaleStepInMerge": 100,
      "UpperScaleStrategy": "RAW",
      "UpperScaleStep": "5"
    },
    "EnableProxyService": true,
    "ProxyServiceStatus": "ONLINE",
    "ProxyClusterId": "proxy-56****a6tg2o",
    "CpuArchitecture": "X86",
    "ReadOnlyResource": {
      "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,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68"
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "UnitSpec": "2C4G",
    "SharedUnitNumLimit": 3,
    "ExclusiveUnitNumLimit": 1,
    "EnableReadOnlyReplica": true,
    "EnableReadOnlyReplicaManagement": false,
    "PrimaryInstance": "ob3h8ytroxxxxx",
    "PrimaryRegion": "cn-hangzhou",
    "SpecType": "dedicatedspec",
    "AllowModifyInternetAddressConnectionLimit": false,
    "AllowCreateProxySqlFirewallRule": false,
    "Iops": 10000
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.