DescribeOutlineBinding - ApsaraDB for OceanBase (Deprecated)

Mengkueri informasi binding Outline atau informasi pembatasan kecepatan untuk pernyataan SQL dalam database berdasarkan SQLID-nya.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TenantId	string	Yes	ID penyewa.	t2mr3oae0****
TableName	string	Yes	Nama penyewa. Panjang nilai harus 2 hingga 20 karakter dan dapat berisi huruf, digit, dan garis bawah. Nilai bersifat case-sensitive dan harus diawali dengan huruf atau garis bawah. Nilai tidak dapat diatur ke sys.	pay_online
DatabaseName	string	Yes	Nama database.	testdb
SQLId	string	Yes	SQLID.	8D6E84**0B8FB1823D199E2CA1**
IsConcurrentLimit	boolean	No	Saat diatur ke True, mengkueri informasi pembatasan kecepatan untuk SQLID dalam database. Saat diatur ke False, mengkueri informasi indeks terikat atau rencana eksekusi terikat untuk SQLID dalam database.	false
InstanceId	string	No	ID kluster OceanBase.	ob317v4uif****
DynamicSql	boolean	No	Apakah merupakan SQL templat.
FormatSqlId	string	No	ID SQL format.

Elemen respons

Element	Type	Description	Example
	object	Hasil respons.
OutlineBinding	object	Informasi binding.
BindPlan	string	Rencana binding.	PHY_TABLE_SCAN \| bmsql_order_line \| 40 ******
OutlineId	integer	OutlineID.	-1
BindIndex	string	Indeks binding.	PRIMARY
MaxConcurrent	integer	Konkurensi maksimum.	2
TableName	string	Nama tabel.	cluster_info
SqlText	string	Teks SQL yang dibatasi kecepatannya.
SqlTextConcurrentNum	integer	Nilai pembatasan kecepatan.
ByFormatSqlId	boolean	Apakah merupakan binding fuzzy.
RequestId	string	ID permintaan.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Contoh

Respons sukses

JSONformat

{
  "OutlineBinding": {
    "BindPlan": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
    "OutlineId": -1,
    "BindIndex": "PRIMARY",
    "MaxConcurrent": 2,
    "TableName": "cluster_info",
    "SqlText": "",
    "SqlTextConcurrentNum": 0,
    "ByFormatSqlId": false
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

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.