All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):DescribeRecommendIndex

Last Updated:Jun 12, 2026

Mengkueri informasi rekomendasi indeks dari mesin diagnostik untuk pernyataan SQL berdasarkan ID SQL.

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:DescribeRecommendIndex

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

TenantId

string

Yes

ID penyewa.

t2mr3oae0****

InstanceId

string

Yes

ID Kluster OceanBase.

ob317v4uif****

SQLId

string

Yes

ID SQL. Anda dapat memperoleh ID SQL dari tanggapan operasi DescribeSlowSQLList atau DescribeTopSQLList.

8D6E84****0B8FB1823D199E2CA1****

Elemen respons

Element

Type

Description

Example

object

Parameter tanggapan.

RequestId

string

ID permintaan.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

RecommendIndex

object

Informasi indeks yang direkomendasikan.

SuggestIndex

string

Indeks yang direkomendasikan oleh mesin diagnostik untuk pernyataan SQL.

  • Jika indeks yang direkomendasikan adalah kunci utama, PRIMARY akan dikembalikan.

  • Jika indeks yang direkomendasikan adalah indeks yang dibuat pengguna, nama indeks akan dikembalikan.

Sistem saat ini hanya merekomendasikan satu indeks untuk setiap pernyataan SQL. Anda dapat memanggil operasi DescribeIndexes untuk Tampilan data indeks tabel.

PRIMARY

TenantMode

string

Mode penyewa. Nilai valid:

  • Oracle: Mode Oracle.

  • MySQL: Mode MySQL.

mysql

TableList

string

Informasi tabel.
Mengembalikan tabel yang terlibat dalam pernyataan SQL yang sesuai dengan ID SQL. Jika pernyataan SQL adalah kueri tabel tunggal, tabel yang diakses akan dikembalikan. Jika pernyataan SQL adalah kueri JOIN, semua tabel yang diakses akan dikembalikan, dipisahkan oleh garis vertikal, seperti "Table1|Table2".

testtable

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "RecommendIndex": {
    "SuggestIndex": "PRIMARY",
    "TenantMode": "mysql",
    "TableList": "testtable"
  }
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

2014 InternalError The request processing has failed due to some unknown error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.