Kueri Instans Node dengan API ListInstances - DataWorks - Alibaba Cloud -

Mengkueri daftar instans.

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

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	Lingkungan tempat node dijalankan. Nilai yang valid: DEV dan PROD.	PROD
NodeId	integer	No	Menunjukkan apakah instans dikaitkan dengan aturan pemantauan di Data Quality. Nilai yang valid: 0: Instans dikaitkan dengan aturan pemantauan di Data Quality. 1: Instans tidak dikaitkan dengan aturan pemantauan di Data Quality.	100000000000
NodeName	string	No	Menunjukkan apakah node dapat dijalankan ulang.	openmr_8****
Owner	string	No	String koneksi.	193379****
ProjectId	integer	Yes	ID baseline.	12345
BizName	string	No	ID instans.	test_bizName
ProgramType	string	No	Kode kesalahan yang dikembalikan.	ODPS_SQL
PageNumber	integer	No	Operasi yang ingin Anda lakukan.	1
PageSize	integer	No	ID node.	10
DagId	integer	No	Lingkungan workspace. Nilai yang valid: PROD dan DEV. Nilai PROD menunjukkan lingkungan produksi. Nilai DEV menunjukkan lingkungan pengembangan.	11111
Bizdate	string	No	Jumlah entri yang dikembalikan per halaman. Nilai default: 10. Nilai maksimum: 100.	2020-02-02 00:00:00
BeginBizdate	string	No	Parameter yang terkait dengan node.	2020-02-02 00:00:00
EndBizdate	string	No	ID alur kerja.	2020-02-03 00:00:00
Status	string	No	Status node. Nilai yang valid: NOT_RUN: Node tidak dijalankan. WAIT_TIME: Node menunggu waktu penjadwalan tiba. WAIT_RESOURCE: Node menunggu sumber daya. RUNNING: Node sedang berjalan. CHECKING: Kualitas data sedang diperiksa untuk node. CHECKING_CONDITION: Kondisi cabang sedang diperiksa untuk node. FAILURE: Node gagal dijalankan. SUCCESS: Node berhasil dijalankan.	NOT_RUN
OrderBy	string	No	Aturan pengurutan instans yang akan dikembalikan. Nilai yang valid: CREATE_TIME_DESC: Instans diurutkan dalam urutan menurun berdasarkan waktu pembuatannya. INSTANCE_ID_DESC (default): Instans diurutkan dalam urutan menurun berdasarkan ID-nya.	INSTANCE_ID_DESC

Elemen respons

Element	Type	Description	Example
	object	Instans yang dikembalikan.
HttpStatusCode	integer	Pesan kesalahan yang dikembalikan untuk instans. Parameter ini sudah tidak digunakan lagi. Anda dapat memanggil operasi GetInstanceLog untuk mengkueri informasi kesalahan yang terkait dengan node.	200
RequestId	string	Nama node.	E6F0DBDD-5AD****
ErrorMessage	string	Nomor halaman dari halaman yang dikembalikan.	The project does not exist.
ErrorCode	string	Kode status HTTP yang dikembalikan.	Invalid.Tenant.ProjectNotExists
Success	boolean	Awal rentang waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-dd HH:mm:ss.	true
Data	object	ID node. Anda dapat memanggil operasi ListNodes untuk mengkueri ID node.
PageNumber	integer	Waktu ketika node dijadwalkan untuk dijalankan.	1
PageSize	integer	Akhir rentang waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-dd HH:mm:ss.	10
TotalCount	integer	Prioritas instans. Nilai yang valid: 1, 3, 5, 7, dan 8. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi. Nilai default: 1.	66
Instances	array<object>	Nama node. Anda dapat memanggil operasi ListNodes untuk mengkueri nama node.
	object	Waktu ketika instans dibuat.
Status	string	The data timestamp of the instances that you want to query. Specify the timestamp in the yyyy-MM-dd HH:mm:ss format.	NOT_RUN
CycTime	integer	The error message returned.	1590422400000
BeginRunningTime	integer	The time when the instance started to run.	1590416703313
FinishTime	integer	The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page of the Account Center console.	1590416703313
ErrorMessage	string	The name of the account that is used to run the instance. For example, if an account named Test was used to run the instance to backfill data, the value of this parameter is Test.	error message
CreateTime	integer	The interval at which the node is rerun after the node fails to run. Unit: milliseconds.	1590416703313
DagId	integer	The time when the instance started to wait for resources.	33845
Priority	integer	The total number of instances.	1
TaskType	string	The information about the instances.	NORMAL(0)
ParamValues	string	The table and partition filter expression in Data Quality that are associated with the node.	bizdate=$bizdate tbods=$tbods
Connection	string	The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0. If the value of this parameter is empty, the number of times that the node can be rerun is not specified. If the value of this parameter is 0, the node cannot be rerun. If the value of this parameter is a positive integer such as n, the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun once. If the value of this parameter is 2, the node can be rerun twice.	odps_first
BaselineId	integer	The type of the workflow. Valid values: DAILY: The workflow is used to run auto triggered nodes. MANUAL: The workflow is used to run manually triggered nodes. SMOKE_TEST: The workflow is used to perform smoke testing. SUPPLY_DATA: The workflow is used to backfill data.	123123
DqcType	integer	The status of the node. Valid values: NOT_RUN: The node is not run. WAIT_TIME: The node is waiting for the scheduling time to arrive. WAIT_RESOURCE: The node is waiting for resources. RUNNING: The node is running. CHECKING: Data quality is being checked for the node. CHECKING_CONDITION: Branch conditions are being checked for the node. FAILURE: The node fails to run. SUCCESS: The node is successfully run.	1
DagType	string	The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.	DAILY
BusinessId	integer	The ID of the workflow to which the node belongs.	123
TaskRerunTime	integer	The ID of the workspace. You can call the ListProjects operation to query the ID of the workspace.	0
ModifyTime	integer	The name of the workflow. You can call the ListBusiness operation to query the name of the workflow.	1590416703313
Repeatability	boolean	The status of the node. Valid values: NOT_RUN: The node is not run. WAIT_TIME: The node is waiting for the scheduling time to arrive. WAIT_RESOURCE: The node is waiting for resources. RUNNING: The node is running. CHECKING: Data quality is being checked for the node. CHECKING_CONDITION: Branch conditions are being checked for the node. FAILURE: The node fails to run. SUCCESS: The node is successfully run.	true
RepeatInterval	integer	The scheduling type of the node. Valid values: NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node. MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node. PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node. SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node. SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to succeeded when the scheduling system starts to run the node. SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node. CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node. REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to succeeded.	60000
InstanceId	integer	The number of the page to return. Minimum value:1. Maximum value: 100.	1234
BeginWaitResTime	integer	The time when the node stopped running.	1590416703313
RelatedFlowId	integer	The type of the node. You can call the ListNodes operation to query the type of the node.	123456
Bizdate	integer	The number of entries to return on each page. Default value: 10. Maximum value: 100. You cannot specify the sorting method for the instances to be returned by this operation. By default, the instances are sorted in descending order of the time when the instances were created.	1590336000000
NodeName	string	The ID of the workflow.	kzh
BeginWaitTimeTime	integer	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	1590416703313
DqcDescription	string	The operation that you want to perform.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeId	integer	The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.	33115
CreateUser	string	The ID of the node. You can call the ListNodes operation to query the ID of the node.	Test

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_first",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.