Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map/ Output Information (Invitational Test)
Updated on 2025-11-17 GMT+08:00
View PDF

Output Information (Invitational Test)

Function

This API is used to query the running instance information of the job operator related to a table. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/datamap/node/{task_id}/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

task_id

Yes

String

Job operator ID, that is, task_id in the response body of the API for associating a table with a job operator list.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspace_id

No

String

Space ID, which is workspace_id of the response body of the API for associating a table with a job operator list.

job_name

Yes

String

Job operator name, which is job_name in the response body of the API for associating a table with a job operator list.

start_time

Yes

Number

Start time of the search parameter time range, for example, 1705248000000.

end_time

Yes

Number

End time of the search parameter time range, for example, 1705311669796.

offset

Yes

Integer

Offset of the pagination parameter.

limit

Yes

Integer

Number of records on each page.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

instance

Yes

String

Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status_code

Integer

Response code.

body

String

Response body.

header_map

Object

Response header information.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK.

{
  "status_code" : 200,
  "body" : "{\n\t \"msg\":\"success\",\n\t \"rows\":[\n\t\t {\n\t\t\t \"endTime\":0,\n\t\t\t \"executionLogPath\":\"obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/b88c445407b24283aa949f9833a38fd8/etl-dli2dws/2024-01-11_09_01_39.684/ETL_Job_dli2dws/ETL_Job_dli2dws.job\",\n\t\t\t \"failCount\":-1,\n\t\t\t \"forceSuccess\":0,\n\t\t\t \"inputRowCount\":-1,\n\t\t\t \"jobId\":1,\n\t\t\t \"jobName\":\"ETL_Job_dli2dws\",\n\t\t\t \"outputRowCount\":-1,\n\t\t\t \"owner\":\"username\",\n\t\t\t \"planTime\":1704934907000,\n\t\t\t \"retryTimes\":0,\n\t\t\t \"runningData\":\"{\\\"obsDataPath\\\":\\\"obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/1e490376-4778-3a55-a2f5-76b4ac707a87/20240111090152_YqBe/obsData/\\\",\\\"jobId\\\":\\\"ca7ec295-0fe7-4fe9-bb2e-30f946334b28\\\",\\\"dliCurrentStep\\\":\\\"1\\\",\\\"firstTimeEtlSqlList\\\":\\\"Create table if NOT EXISTS wk.wk_shuju_temp_20240111090152_RVo0 (\\\\n  num int,\\\\n  sno string,\\\\n  name string\\\\n) using csv options(\\\\n  path 'obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/1e490376-4778-3a55-a2f5-76b4ac707a87/20240111090152_YqBe/obsData/',mode 'DROPMALFORMED'\\\\n);\\\\nINSERT into TABLE wk.wk_shuju_temp_20240111090152_RVo0\\\\n  select\\\\n      num,\\\\n      sno,\\\\n      name\\\\n  from wk.wk_shuju   ;\\\\ndrop table if exists wk.wk_shuju_temp_20240111090152_RVo0;\\\",\\\"type\\\":\\\"DLI\\\"}\",\n\t\t\t \"runningParam\":\"{\\\"total\\\":1,\\\"rows\\\":[{\\\"name\\\":\\\"running parameter\\\",\\\"value\\\":\\\"com.hwclouds.dataide.lts.plugins.hwclouds.etl.ETLJobRunner;dps;dps\\\"}]}\",\n\t\t\t \"runningTime\":0,\n\t\t\t \"speed\":0.0,\n\t\t\t \"startTime\":1704934916000,\n\t\t\t \"status\":\"running\",\n\t\t\t \"submitTime\":1704934907691,\n\t\t\t \"taskId\":937987,\n\t\t\t \"taskName\":\"etl-dli2dws\",\n\t\t\t \"taskRunningLogId\":126074594,\n\t\t\t \"type\":\"ETLJob\",\n\t\t\t \"workspaceId\":\"b88c445407b24283aa949f9833a38fd8\",\n\t\t\t \"workspaceName\":\"kw_test\"\n\t\t }\n\t ],\n\t \"success\":true,\n\t \"total\":1\n}",
  "header_map" : {
    "Keep-Alive" : "timeout=20",
    "Server" : "CloudMiddleWareTomcat",
    "X-Request-Id" : "e8c092e7-2acf-4f26-ab84-80f296352d99-1704936562490-scheduler03",
    "X-Content-Type-Options" : "nosniff",
    "Connection" : "keep-alive",
    "Pragma" : "no-cache",
    "Date" : "Thu, 11 Jan 2024 01:29:22 GMT",
    "X-Frame-Options" : "SAMEORIGIN",
    "Cache-Control" : "no-cache, no-store, must-revalidate",
    "Expires" : "Thu, 01 Jan 1970 00:00:00 GMT",
    "X-XSS-Protection" : "1; mode=block",
    "Content-Length" : "1692",
    "Content-Type" : "application/json;charset=UTF-8"
  }
}

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.
Parent Topic: Data Map