Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Viewing Job Instance Details

Updated on 2024-11-06 GMT+08:00

Function

This API is used to view job instance details, including the execution information about each node in a job instance.

URI

  • URI format

    GET /v1/{project_id}/jobs/{job_name}/instances/{instance_id}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

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

    job_name

    Yes

    String

    Job name

    instance_id

    Yes

    string

    Job instance ID. For details about how to obtain the ID, see the response parameters in Viewing a Job Instance List.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

Response Parameters

Table 3 Response parameters

Parameter

Mandatory

Type

Description

jobName

Yes

String

Job name

instanceId

Yes

Long

Job instance ID

status

Yes

String

Job instance status.

  • waiting
  • running
  • success
  • fail
  • running-exception
  • pause
  • manual-stop

planTime

Yes

Long

Planned execution time of the job instance

startTime

Yes

Long

Actual execution start time of the job instance

endTime

No

Long

Actual execution end time of the job instance

executeTime

No

Long

Execution duration in milliseconds

total

Yes

Integer

Total number of node records

nodes

Yes

List<Node>

Node instance status. For details, see Table 4.

instanceType

Yes

Integer

Job scheduling modes.

  • 0: General scheduling
  • 2: Manual scheduling
  • 5: PatchData
  • 6: Subjob scheduling
  • 7: Schedule once

forceSuccess

No

boolean

Whether the job instance status is forcibly successful

Default value: false

ignoreSuccess

No

boolean

Whether the job instance status is failure ignored

Default value: false

Table 4 Node parameters

Parameter

Mandatory

Type

Description

nodeName

Yes

String

Node name

status

Yes

String

Node status.

  • waiting
  • running
  • success
  • fail
  • skip
  • pause
  • manual-stop

queue

Yes

String

DLI resource queue name

NOTE:

Only the DLI SQL or DLI SPARK operator returns the DLI queue name in the response.

planTime

Yes

Long

Planned execution time of the job instance

startTime

Yes

Long

Actual execution start time of the node

endTime

No

Long

Actual execution end time of the node

type

Yes

String

Node type.

  • Hive SQL: runs Hive SQL scripts.
  • Spark SQL: runs Spark SQL scripts.
  • DWS SQL: runs DWS SQL scripts.
  • DLI SQL: runs DLI SQL scripts.
  • Shell: runs shell SQL scripts.
  • CDM Job: runs CDM jobs.
  • DIS Transfer Task: creates DIS dump tasks.
  • CloudTableManager: manages CloudTable tables, including creating and deleting tables.
  • OBS Manager: manages OBS paths, including creating and deleting paths.
  • RestClient: sends REST API requests.
  • SMN: sends short messages or emails.
  • MRS Spark: runs Spark jobs of MRS.
  • MapReduce: Runs MapReduce jobs of MRS.
  • MRSFlinkJob: runs FlinkJob jobs of MRS.
  • MRS HetuEngine: runs HetuEngine jobs of MRS.
  • DLI Spark: runs Spark jobs of DLF.
  • RDSSQL: transfers SQL statements to RDS for execution.
  • ModelArts Train: executes workflow jobs of ModelArts.

retryTimes

No

Integer

Number of attempts upon a failure

instanceId

Yes

Long

Job instance ID

inputRowCount

No

Long

Rows of input data

speed

No

number

Write speed (row/second)

logPath

No

String

Path for storing node execution logs

Example Request

View details about the instance whose ID is 34765 in job job_batch.
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765

Example Response

  • Success response
    {
        "jobName":"job_batch",
        "instanceId":34765,
        "instanceType": 2,
        "status":"fail",
        "planTime":1551425326540,
        "startTime":1551425327000,
        "endTime":1551425387000,
        "executeTime":1,
        "forceSuccess":false,
        "ignoreSuccess":false,
        "total":2,
        "nodes":[
            {
                "endTime":1551671590000,
                "inputRowCount":0,
                "instanceId":34765,
                "nodeName":"Dummy_8556",
                "queue":"dlf_notdelete",
                "planTime":1551671580000,
                "retryTimes":0,
                "startTime":1551671584000,
                "status":"success",
                "type":"Dummy"
            },
            {
                "endTime":1551671598000,
                "inputRowCount":0,
                "instanceId":34765,
                "logPath":"obs://dlf-test-log/job_batch/2019-03-04 11_53_00.000/error/error.job",
                "nodeName":"error",
                "planTime":1551671580000,
                "retryTimes":0,
                "startTime":1551671594000,
                "status":"success",
                "type":"DWS SQL"
            }
        ]
    }
  • Failure response

    HTTP status code 400

    {
        "error_code":"DLF.0137",
        "error_msg":"Job instance does not exist."
    }

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback