Ringkasan API ListColumns untuk Data Map DataWorks-DataWorks-Alibaba Cloud - DataWorks

Deskripsi operasi

Anda harus membeli DataWorks Edisi Dasar atau edisi yang lebih tinggi untuk menggunakan fitur 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

dataworks:ListColumns

list

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
TableId	string	Yes	ID tabel data. Anda dapat memperoleh ID dari tanggapan operasi ListTables. Untuk informasi selengkapnya, lihat Konsep entitas metadata.	maxcompute-table:::project_name:[schema_name]:table_name
Name	string	No	Nama. Pencocokan kabur didukung.	test_table
Comment	string	No	Komentar. Pencocokan kabur didukung.	test comment
SortBy	string	No	Bidang pengurutan. Nilai default: Position. Nilai valid: Name: nama Position: posisi	Position
Order	string	No	Arah pengurutan. Nilai default: Asc. Nilai valid: Asc: Urutan menaik Desc: Urutan menurun	Asc
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Apakah permintaan berhasil.	true
PagingInfo	object	Hasil paging.
TotalCount	integer	Jumlah total rekaman.	1
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
Columns	array	Daftar kolom.
	Column	Informasi kolom.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Columns": [
      {
        "Id": "maxcompute-column:::project_name:[schema_name]:table_name:column_name",
        "Name": "column_name",
        "Comment": "字段1",
        "TableId": "maxcompute-table:::project_name:[schema_name]:table_name",
        "Position": 1,
        "Type": "bigint",
        "PrimaryKey": false,
        "PartitionKey": false,
        "ForeignKey": false,
        "BusinessMetadata": {
          "Description": "字段1的业务描述",
          "CustomAttributes": {
            "key": [
              "张三"
            ]
          }
        },
        "StatisticsInfos": {
          "key": ""
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.