Referensi field API ListTableColumns-Data Management-Alibaba Cloud - Data Management

Mengkueri informasi kolom dari sebuah tabel.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Tid	integer	No	ID penyewa. Anda dapat memanggil operasi GetUserActiveTenant atau ListUserTenants untuk mendapatkan nilai parameter ini.	3***
DbId	integer	Yes	ID database fisik. Anda dapat memanggil operasi ListDatabases atau SearchDatabase untuk mendapatkan nilai parameter ini.	123
TableName	string	Yes	Nama tabel. Catatan Anda dapat memanggil operasi ListTables untuk mendapatkan nilai parameter ini.	100g_customer
TableSchemaName	string	No	Nama skema tabel. Parameter ini harus dilewatkan sebagai nama skema hanya ketika database adalah SQL Server.	dbo

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	Kode kesalahan yang dikembalikan ketika permintaan gagal.	UnknownError
ColumnList	object
Column	array<object>	Daftar informasi kolom.
	object
ColumnId	string	The ID of the field.	12345
ColumnType	string	The data type of the field.	varchar
Description	string	The description of the field.	column desc
AutoIncrement	boolean	Indicates whether the field is an auto-increment field. Valid values: true: The field is an auto-increment field. false: The field is not an auto-increment field.	false
FunctionType	string	The type of the masking algorithm that is used for the field. Valid values: null: No masking algorithm is used. DEFAULT: A full masking algorithm is used. FIX_POS: The fixed position is masked. FIX_CHAR: The fixed characters are replaced.	NULL
DataPrecision	integer	The number of valid digits for the column.	0
DefaultValue	string	The default value of the column.	aaa
ColumnName	string	The field name.	c1
SecurityLevel	string	The security level of the field. Valid values: INNER: The field is an internal field but not sensitive. SENSITIVE: The field is sensitive. CONFIDENTIAL: The field is a confidential column.	INNER
DataScale	integer	The number of decimal places of the field data.	0
DataLength	integer	The length of the field.	32
Sensitive	boolean	Indicates whether the field is a sensitive column. Valid values: true: The field is a sensitive field. false: The field is not a sensitive field.	false
Nullable	boolean	Indicates whether the field can be empty. Valid values: true: The field can be empty. false: The field cannot be empty.	true
ErrorMessage	string	Pesan kesalahan yang dikembalikan ketika pemanggilan gagal.	UnknownError
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnId": "12345",
        "ColumnType": "varchar",
        "Description": "column desc",
        "AutoIncrement": false,
        "FunctionType": "NULL",
        "DataPrecision": 0,
        "DefaultValue": "aaa",
        "ColumnName": "c1",
        "SecurityLevel": "INNER",
        "DataScale": 0,
        "DataLength": 32,
        "Sensitive": false,
        "Nullable": true
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.