Referensi API ListNodes untuk kueri node DataStudio - DataWorks - Alibaba Cloud - DataWorks

Mengambil daftar node pengembangan data dengan paginasi yang dapat difilter berdasarkan kriteria yang ditentukan.

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

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID workspace DataWorks. Untuk menemukan ID ini, masuk ke konsol DataWorks dan buka halaman konfigurasi workspace.	12345
Scene	string	No	Konteks untuk memfilter node. Dalam pengembangan data, ini sesuai dengan bagian-bagian di pohon direktori di sebelah kiri. Jika Anda menghilangkan parameter ini, tidak ada pemfilteran yang diterapkan. Nilai yang valid: DataworksProject: Node di direktori proyek. DataworksManualWorkflow: alur kerja manual DataworksManualTask: tugas manual	DataworksProject
ContainerId	string	No	ID container. Jika Anda menentukan parameter ini, hanya node di container yang ditentukan yang dikembalikan. Parameter ini tidak bergantung pada grup sumber daya (ResourceGroupId). Penting Parameter ini bertipe Long pada versi SDK sebelum 8.0.0 dan bertipe String pada SDK 8.0.0 dan yang lebih baru. Perubahan ini tidak memengaruhi penggunaan SDK. Parameter dikembalikan dalam tipe yang ditentukan untuk versi SDK Anda. Perubahan tipe dapat menyebabkan kesalahan kompilasi hanya jika Anda meningkatkan SDK melintasi versi 8.0.0. Dalam kasus ini, Anda harus memperbaiki tipe data secara manual.	860438872620113XXXX
Recurrence	string	No	Memfilter node berdasarkan tipe penjadwalannya. Nilai yang valid: Normal: Node berjalan sesuai jadwal. Pause: Node dijeda dan memblokir node downstream yang bergantung padanya. Skip: Node dilewati, dan sistem segera mengembalikan status berhasil dengan waktu eksekusi 0 detik. Tindakan ini tidak memblokir node downstream atau menggunakan sumber daya.	Normal
RerunMode	string	No	Mode rerun. Nilai yang valid: Allowed: Node dapat dijalankan ulang terlepas dari apakah berhasil atau gagal. FailureAllowed: Node dapat dijalankan ulang hanya jika eksekusi sebelumnya gagal. Denied: Node tidak dapat dijalankan ulang terlepas dari apakah berhasil atau gagal.	Allowed
Name	string	No	Nama node. Pencarian fuzzy didukung.	test
PageNumber	integer	No	Nomor halaman hasil yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri per halaman. Default: 10. Maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan. Anda dapat menggunakan ID ini untuk menemukan log dan memecahkan masalah.	2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo	object	Informasi paginasi.
TotalCount	string	Jumlah total entri yang memenuhi kriteria filter yang ditentukan.	42
PageSize	string	Jumlah entri yang dikembalikan per halaman.	10
PageNumber	string	Nomor halaman dari data yang dikembalikan.	1
Nodes	array<object>	Daftar node.
	array<object>	Detail node.
Description	string	The description of the node.	Node description
Name	string	The name of the node.	test
ProjectId	integer	The ID of the DataWorks workspace. To obtain the ID, log on to the DataWorks console and go to the Workspace Management page.	33233
Owner	string	The owner of the data development node.	110755000425XXXX
CreateTime	integer	The time when the data development node was created.	1722910655000
ModifyTime	integer	The time when the data development node was last modified.	1722910655000
DataSource	object	The data source.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
TaskId	integer	The ID of the scheduling task.	88888888888
Tags	array<object>	The tags for the node. This parameter is reserved and is not used.
	object	A single tag. This parameter is reserved and is not used.
Key	string	The tag key.	null
Value	string	The tag value.	null
Strategy	object	The scheduling strategy.
Timeout	integer	The timeout period.	0
InstanceMode	string	The instance generation mode. T+1 Immediately	T+1
RerunMode	string	The rerun mode. Allowed Denied FailureAllowed	Allowed
RerunTimes	integer	The number of retries.	3
RerunInterval	integer	The retry interval, in milliseconds.	180000
Outputs	object	The outputs of the node.
Variables	array<object>	A list of output variables.
	array<object>	An output variable.
Name	string	The name of the variable.	output
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the variable. NodeParameter NodeContext Workflow Workspace	NodeParameter
Type	string	The type of the variable. NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	The value of the variable.	111
Node	object	The node to which the variable belongs.
Output	string	The output of the source node.	860438872620113XXXX
Id	string	The ID of the variable. Penting The data type of this parameter is `Long` in SDK versions earlier than 8.0.0 and `String` in SDK 8.0.0 and later. This change does not affect SDK functionality, as the API returns the parameter with the type defined in your SDK version. However, when you upgrade your SDK across the 8.0.0 boundary, this type change may cause a compilation error. If this occurs, you must manually update the data type in your code.	623731286945488XXXX
NodeOutputs	array<object>	A list of node outputs.
	object	A node output.
Data	string	The output of the node.	860438872620113XXXX
RefTableName	string		testProject.testTableName
Tables	array<object>	A list of output tables.
	object	An output table.
Guid	string	The unique identifier of the table.	odps.autotest.test_output_table_1
Inputs	object	The inputs of the node.
Variables	array<object>	A list of input variables.
	array<object>	An input variable.
Name	string	The name of the variable.	input
ArtifactType	string	The artifact type.	Variable
Scope	string	The scope of the input variable. Workspace NodeParameter NodeContext Workflow	NodeParameter
Type	string	The type of the variable. NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	The value of the variable.	222
Node	object	The node to which the variable belongs.
Output	string	The output of the source node.	623731286945488XXXX
Id	string	The ID of the variable. Penting The data type of this parameter is `Long` in SDK versions earlier than 8.0.0 and `String` in SDK 8.0.0 and later. This change does not affect SDK functionality, as the API returns the parameter with the type defined in your SDK version. However, when you upgrade your SDK across the 8.0.0 boundary, this type change may cause a compilation error. If this occurs, you must manually update the data type in your code.	543211286945488XXXX
NodeOutputs	array<object>	A list of outputs from upstream nodes.
	object	An output from an upstream node.
Data	string	The output of the node.	623731286945488XXXX
RefTableName	string		testProject.testTableName
Tables	array<object>	A list of input tables.
	object	An input table.
Guid	string	The unique identifier of the table.	odps.autotest.test_output_table_1
Trigger	object	The trigger.
Type	string	The type of the trigger. Valid values: `Scheduler`: periodic scheduling `Manual`: manual trigger `Streaming`: streaming task	Scheduler
Cron	string	The cron expression for scheduling.	00 00 00 * * ?
StartTime	string	The start of the trigger's validity period.	1970-01-01 00:00:00
EndTime	string	The end of the trigger's validity period.	9999-01-01 00:00:00
Timezone	string	The time zone.	Asia/Shanghai
Id	string	The ID of the trigger. Penting The data type of this parameter is `Long` in SDK versions earlier than 8.0.0 and `String` in SDK 8.0.0 and later. This change does not affect SDK functionality, as the API returns the parameter with the type defined in your SDK version. However, when you upgrade your SDK across the 8.0.0 boundary, this type change may cause a compilation error. If this occurs, you must manually update the data type in your code.	543680677872062XXXX
Script	object	The details of the script.
Path	string	The path of the script.	root/demo
Runtime	object	The runtime environment.
Command	string	The command. This parameter identifies the node type.	ODPS_SQL
Id	string	The ID of the script. Penting The data type of this parameter is `Long` in SDK versions earlier than 8.0.0 and `String` in SDK 8.0.0 and later. This change does not affect SDK functionality, as the API returns the parameter with the type defined in your SDK version. However, when you upgrade your SDK across the 8.0.0 boundary, this type change may cause a compilation error. If this occurs, you must manually update the data type in your code.	853573334108680XXXX
RuntimeResource	object	The details of the resource group.
ResourceGroupId	string	The ID of the resource group.	123456XXX
ResourceGroup	string	The identifier of the resource group. To obtain this identifier, call the ListResourceGroups operation.	S_res_group_XXXX
Recurrence	string	The scheduling type. Valid values: `Normal`: The node runs as scheduled. `Pause`: The node is paused and blocks the downstream nodes that depend on it. `Skip`: The node is dry-run. The system immediately returns a success status for the node with an execution time of 0s. This process does not block downstream nodes or consume resources.	Normal
Id	string	The unique identifier of the data development node. Penting The data type of this parameter is `Long` in SDK versions earlier than 8.0.0 and `String` in SDK 8.0.0 and later. This change does not affect SDK functionality, as the API returns the parameter with the type defined in your SDK version. However, when you upgrade your SDK across the 8.0.0 boundary, this type change may cause a compilation error. If this occurs, you must manually update the data type in your code.	860438872620113XXXX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description\n",
        "Name": "test",
        "ProjectId": 33233,
        "Owner": "110755000425XXXX",
        "CreateTime": 1722910655000,
        "ModifyTime": 1722910655000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 88888888888,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output\n",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "623731286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Node": {
                "Output": "623731286945488XXXX"
              },
              "Id": "543211286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai",
          "Id": "543680677872062XXXX"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "123456XXX",
          "ResourceGroup": "S_res_group_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "860438872620113XXXX"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.