All Products
Search
Document Center

Data Management:ListColumns

Last Updated:Jun 11, 2026

Mengembalikan informasi kolom tabel.

Deskripsi operasi

Hanya instans database yang mode kontrolnya adalah Kolaborasi Keamanan yang dapat memanggil API ini.

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

list

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

Tid

integer

No

ID penyewa. Anda dapat memanggil operasi GetUserActiveTenant untuk mendapatkan parameter ini.

3***

TableId

string

Yes

ID tabel. Anda dapat memanggil operasi ListTables untuk mendapatkan parameter ini.

39281****

Logic

boolean

No

Apakah database merupakan database logis. Nilai valid:

  • true: database logis

  • false: database fisik.

false

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

0AD9AC55-5873-474A-9F33-4285806A3619

ErrorCode

string

Kode kesalahan.

UnknownError

ColumnList

object

Column

array<object>

Detail kolom.

object

Daftar kolom.

ColumnType

string

The data type of the column.

varchar

AutoIncrement

boolean

Indicates whether the column is an auto-increment column. Valid values:

  • true: The column is an auto-increment column.

  • false: The column is not an auto-increment column.

false

ColumnId

string

The ID of the column.

62589****

DefaultValue

string

The default value of the column.

def_value

Sensitive

boolean

Indicates whether the column is a sensitive column. Valid values:

  • true: The column is a sensitive column.

  • false: The column is not a sensitive column.

false

ColumnName

string

The name of the column.

name

SecurityLevel

string

The security level of the column. Valid values:

  • INNER: The column is an internal column but not sensitive.

  • SENSITIVE: The column is a sensitive column.

  • CONFIDENTIAL: The column is a confidential column.

Catatan

For more information, see Sensitivity levels of fields.

INNER

Description

string

The description of the column.

test

DataPrecision

integer

The number of valid digits for the field.

0

DataScale

integer

The number of decimal places for the field.

0

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.

DEFAULT

Nullable

boolean

Indicates whether the column can be empty. Valid values:

  • true: The column can be empty.

  • false: The column cannot be empty.

false

DataLength

integer

The length of the field.

4

ErrorMessage

string

Paket kesalahan.

UnknownError

Success

boolean

Apakah permintaan berhasil. Nilai valid:

  • true: berhasil

  • false: gagal.

true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0AD9AC55-5873-474A-9F33-4285806A3619",
  "ErrorCode": "UnknownError",
  "ColumnList": {
    "Column": [
      {
        "ColumnType": "varchar",
        "AutoIncrement": false,
        "ColumnId": "62589****",
        "DefaultValue": "def_value",
        "Sensitive": false,
        "ColumnName": "name",
        "SecurityLevel": "INNER",
        "Description": "test",
        "DataPrecision": 0,
        "DataScale": 0,
        "FunctionType": "DEFAULT",
        "Nullable": false,
        "DataLength": 4
      }
    ]
  },
  "ErrorMessage": "UnknownError",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.