Ikhtisar API SearchTable untuk Pencarian Tabel DMS - Manajemen Data - Alibaba Cloud - Data Management

Mengkueri detail tabel.

Deskripsi operasi

Anda hanya dapat memanggil operasi ini untuk instans database yang mode kontrolnya adalah Security Collaboration.

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

dms:SearchTable

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Tid	integer	No	ID penyewa. Catatan Untuk mendapatkan ID penyewa, arahkan pointer ke gambar profil di sudut kanan atas Konsol manajemen data (DMS). Untuk informasi selengkapnya, lihat Melihat informasi tentang penyewa saat ini.	1
SearchKey	string	No	Kata kunci yang digunakan untuk mencari nama tabel.	test
PageNumber	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman.	10
EnvType	string	No	Tipe lingkungan tempat database berada. Untuk informasi selengkapnya, lihat Mengubah tipe lingkungan instans.	PRODUCT
SearchRange	string	No	Cakupan izin. Nilai valid: HAS_PERMSSION: tabel yang Anda miliki izinnya. OWNER: tabel yang Anda miliki. MY_FOCUS: tabel yang Anda ikuti. UNKNOWN: tanpa batas.	OWNER
SearchTarget	string	No	Tipe tabel yang ingin Anda kueri. Nilai valid: TABLE: tabel fisik dan tabel logis. SINGLE_TABLE: tabel fisik. LOGIC_TABLE: tabel logis.	LOGIC_TABLE
DbType	string	No	Tipe database. Nilai valid: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis.	MySQL
ReturnGuid	boolean	No	Apakah akan mengembalikan ID Unik Global (GUID) tabel.	false

Elemen respons

Element	Type	Description	Example
	object
SearchTableList	object
SearchTable	array<object>	Detail tabel yang dikueri.
	array<object>
TableId	string	The ID of the table.	1
Description	string	The description of the table.	test
DatabaseId	string	The ID of the database to which the table belongs.	1
Encoding	string	The encoding format of the table.	utf8
DBSearchName	string	The name that is used to search for the database to which the table belongs.	test
EnvType	string	The type of the environment to which the database belongs.	test
DbType	string	The type of the database. Valid values: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	mysql
TableName	string	The name of the table.	test_table
TableGuid	string	The GUID of the table.	IDB_L_9032.db-test.yuyang_test
TableSchemaName	string	The name of the database to which the table belongs.	test@xxx.xxx.xxx.xxx:3306
DbName	string	The name of the database.	test
OwnerNameList	object
OwnerNames	array	The nicknames of the table owners.
	string	The nickname of the table owner.	user
Logic	boolean	Indicates whether the table is a logical table. Valid values: true: The table is a logical table. false: The table is not a logical table.	false
OwnerIdList	object
OwnerIds	array	The IDs of the table owners.
	string	The ID of the table owner.	1
Engine	string	The engine of the table.	innodb
TotalCount	integer	Jumlah total entri yang memenuhi kondisi pencarian.	1
RequestId	string	ID permintaan.	1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCode	string	Kode kesalahan yang dikembalikan.	UnknownError
ErrorMessage	string	Paket kesalahan yang dikembalikan.	UnknownError
Success	boolean	Apakah permintaan berhasil.	true

Contoh

Respons sukses

JSONformat

{
  "SearchTableList": {
    "SearchTable": [
      {
        "TableId": "1",
        "Description": "test",
        "DatabaseId": "1",
        "Encoding": "utf8",
        "DBSearchName": "test",
        "EnvType": "test",
        "DbType": "mysql",
        "TableName": "test_table",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "DbName": "test",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "Logic": false,
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Engine": "innodb"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.