Referensi API GetFunction untuk metadata UDF - DataWorks - Alibaba Cloud - DataWorks

Menanyakan informasi tentang fungsi yang ditentukan pengguna (UDF) di DataStudio.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	No	ID ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan membuka halaman Ruang Kerja untuk menanyakan ID. Anda harus mengonfigurasi parameter ini untuk menentukan ruang kerja DataWorks tempat operasi API diterapkan.	10000
Id	string	Yes	Pengidentifikasi unik fungsi UDF. Catatan Bidang ini bertipe Long pada versi SDK sebelum 8.0.0, dan bertipe String pada versi SDK 8.0.0 dan yang lebih baru. Perubahan ini tidak memengaruhi penggunaan normal SDK; parameter tetap dikembalikan sesuai dengan tipe yang ditentukan dalam SDK. Kegagalan kompilasi akibat perubahan tipe hanya dapat terjadi saat meningkatkan SDK melintasi versi 8.0.0, dalam hal ini pengguna perlu memperbaiki tipe data secara manual.	86043887262011****

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX
Function	object	Detail fungsi UDF.
ProjectId	integer	ID ruang kerja DataWorks tempat UDF berada.	10000
Name	string	Nama UDF.	Function name
Owner	string	Pemilik UDF.	110755000425XXXX
CreateTime	integer	Waktu saat UDF dibuat. Nilai ini adalah stempel waktu UNIX.	1724505917000
ModifyTime	integer	Waktu saat UDF terakhir kali dimodifikasi. Nilai ini adalah stempel waktu UNIX.	1724506661000
Spec	string	Informasi bidang FlowSpec tentang UDF. Untuk informasi selengkapnya, lihat FlowSpec.	{ "version": "1.1.0", "kind": "Function", "spec": { "functions": [ { "name": "Function_Name", "id": "580667964888595XXXX", "script": { "content": "{ \"uuid\": \"580667964888595XXXX\", \"name\": \"Function_Name\", \"datasource\": { \"type\": \"odps\", \"name\": \"odps_first\" }, \"runtimeResource\": { \"resourceGroup\": \"S_res_group_XXXX_XXXX\", \"resourceGroupId\": 6591XXXX }}", "path": "XXX/OpenAPI/Function/Function_Name", "runtime": { "command": "ODPS_FUNCTION" } }, "datasource": { "name": "odps_first", "type": "odps" }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "723932906364267XXXX", "resourceGroupId": "6591XXXX" }, "metadata": { "owner": "110755000425XXXX" } } ] } }
Id	string	Pengidentifikasi unik fungsi UDF. Catatan Sebelum versi SDK 8.0.0, bidang ini bertipe Long. Pada versi SDK 8.0.0 dan yang lebih baru, bertipe String. Perubahan ini tidak memengaruhi penggunaan normal SDK. Parameter dikembalikan berdasarkan tipe yang ditentukan dalam SDK. Kegagalan kompilasi yang disebabkan oleh perubahan tipe hanya dapat terjadi saat Anda meningkatkan SDK melintasi versi 8.0.0. Dalam hal ini, Anda harus memperbarui tipe data secara manual.	860438872620113XXXX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "ProjectId": 10000,
    "Name": "Function name",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": "{\n    \"version\": \"1.1.0\",\n    \"kind\": \"Function\",\n    \"spec\": {\n        \"functions\": [\n            {\n                \"name\": \"Function_Name\",\n                \"id\": \"580667964888595XXXX\",\n                \"script\": {\n                    \"content\": \"{  \\\"uuid\\\": \\\"580667964888595XXXX\\\",  \\\"name\\\": \\\"Function_Name\\\",  \\\"datasource\\\": {    \\\"type\\\": \\\"odps\\\",    \\\"name\\\": \\\"odps_first\\\"  },  \\\"runtimeResource\\\": {    \\\"resourceGroup\\\": \\\"S_res_group_XXXX_XXXX\\\",    \\\"resourceGroupId\\\": 6591XXXX  }}\",\n                    \"path\": \"XXX/OpenAPI/Function/Function_Name\",\n                    \"runtime\": {\n                        \"command\": \"ODPS_FUNCTION\"\n                    }\n                },\n                \"datasource\": {\n                    \"name\": \"odps_first\",\n                    \"type\": \"odps\"\n                },\n                \"runtimeResource\": {\n                    \"resourceGroup\": \"S_res_group_XXXX_XXXX\",\n                    \"id\": \"723932906364267XXXX\",\n                    \"resourceGroupId\": \"6591XXXX\"\n                },\n                \"metadata\": {\n                    \"owner\": \"110755000425XXXX\"\n                }\n            }\n        ]\n    }\n}",
    "Id": "860438872620113XXXX\n"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.