Referensi API GetColumn untuk Metadata Kolom Tabel-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:GetColumn

get

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	string	Yes	ID. Anda dapat memperoleh nilai ini dari tanggapan operasi ListColumns. Untuk informasi lebih lanjut, lihat Konsep entitas metadata. Formatnya adalah `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName}:${ColumnName}`. Gunakan string kosong sebagai placeholder untuk level yang tidak ada. Catatan Untuk tipe MaxCompute dan DLF, gunakan string kosong sebagai placeholder untuk ID instans. Untuk MaxCompute, nama database adalah nama proyek MaxCompute. Proyek dengan model tiga lapis yang diaktifkan harus menyertakan nama skema. Untuk proyek tanpa model tiga lapis, gunakan string kosong sebagai placeholder untuk nama skema. Catatan Untuk StarRocks, pengenal katalog data adalah nama katalog. Untuk DLF, pengenal katalog data adalah ID katalog. Tipe lain tidak mendukung level katalog. Gunakan string kosong sebagai placeholder. Berikut adalah contoh format ID untuk tipe umum: `maxcompute-column:::project_name:[schema_name]:table_name:column_name` `dlf-column::catalog_id:database_name::table_name:column_name` `hms-column:instance_id::database_name::table_name:column_name` `holo-column:instance_id::database_name:schema_name:table_name:column_name` `mysql-column:(instance_id\|encoded_jdbc_url)::database_name::table_name:column_name` Catatan Parameter lain: `instance_id`: ID instans. Parameter ini diperlukan saat sumber data didaftarkan dalam mode instans. `encoded_jdbc_url`: String koneksi JDBC yang dienkode URL. Parameter ini diperlukan saat sumber data didaftarkan menggunakan string koneksi. `catalog_id`: ID katalog DLF. `project_name`: Nama proyek MaxCompute. `database_name`: Nama database. `schema_name`: Nama skema. Untuk MaxCompute, parameter ini hanya diperlukan saat model tiga lapis diaktifkan untuk proyek. Jika model tiga lapis tidak diaktifkan, gunakan string kosong sebagai placeholder. `table_name`: Nama tabel. `column_name`: Nama kolom.	maxcompute-column:::project_name:[schema_name]:table_name:column_name

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan.	D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx
Success	boolean	Apakah permintaan berhasil.	true
Column	Column	Daftar kolom.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx",
  "Success": true,
  "Column": {
    "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.