DescribeInstanceSummary - ApsaraDB for OceanBase (Deprecated)

Mengkueri informasi ikhtisar instans 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:DescribeInstanceSummary

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
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

Elemen respons

Element	Type	Description	Example
	object	Hasil pengembalian permintaan.
RequestId	string	ID permintaan.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceSummary	object	Informasi ikhtisar instans.
TotalInstancesCount	integer	Jumlah total instans.	3
OverLoadInstancesCount	integer	Jumlah instans yang kelebihan beban.	1
ImmediatelyExpiredInstancesCount	integer	Jumlah total instans yang kedaluwarsa dan menunggu rilis.	1
RunningInstancesCount	integer	Jumlah instans yang berjalan.	1
InsufficientDiskInstancesCount	integer	Jumlah total kluster dengan risiko kapasitas.	2
ExpiredInstancesCount	integer	Jumlah instans yang kedaluwarsa.	1
AlarmSummaryCount	integer	Jumlah catatan peringatan dalam rentang pengatur waktu kueri.	1
AnomalySQLCount	integer	Jumlah total pernyataan SQL anomali.	1
ClusterInstancesCount	integer	Jumlah instans kluster.	1
TenantInstancesCount	integer	Jumlah instans penyewa.	1
TotalOmsInstancesCount	integer	Jumlah instans transfer data.	1
RegionalInstanceSummaryList	array<object>	Daftar ringkasan instans Wilayah.
	object
Region	string	The ID of the region.	cn-shanghai
TotalInstancesCount	integer	The total number of instances.	3
ImmediatelyExpiredInstancesCount	integer	The number of instances about to expire.	1
RunningInstancesCount	integer	The total number of running instances.	1
ExpiredInstancesCount	integer	The number of expired instances.	1
RecentCreatedInstancesCount	integer	The number of recently created instances.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "InstanceSummary": {
    "TotalInstancesCount": 3,
    "OverLoadInstancesCount": 1,
    "ImmediatelyExpiredInstancesCount": 1,
    "RunningInstancesCount": 1,
    "InsufficientDiskInstancesCount": 2,
    "ExpiredInstancesCount": 1,
    "AlarmSummaryCount": 1,
    "AnomalySQLCount": 1,
    "ClusterInstancesCount": 1,
    "TenantInstancesCount": 1,
    "TotalOmsInstancesCount": 1,
    "RegionalInstanceSummaryList": [
      {
        "Region": "cn-shanghai",
        "TotalInstancesCount": 3,
        "ImmediatelyExpiredInstancesCount": 1,
        "RunningInstancesCount": 1,
        "ExpiredInstancesCount": 1,
        "RecentCreatedInstancesCount": 1
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.