Skip to main content

ListSupportActive

Retrieves a list of support jobs for Data Proc cluster.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListJobsRequest = cloudApi.dataproc.manager_job_service.ListJobsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.JobServiceClient);

  const result = await client.listSupportActive(
    ListJobsRequest.fromPartial({
      // clusterId: "clusterId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListJobsRequest​

clusterId : string​

Required. ID of the cluster to list Data Proc jobs of.

pageSize : int64​

The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a next_page_token that can be used to get the next page of results in subsequent ListJobs requests. Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken : string​

Page token. Set page_token to the next_page_token returned by a previous ListJobs request to get the next page of results.

filter : string​

String that describes a display filter.

ListSupportJobsResponse​

jobs : SupportJob​

Requested list of Data Proc jobs.

nextPageToken : string​

This token allows you to get the next page of results for ListJobs requests, if the number of results is larger than page_size specified in the request. To get the next page, specify the value of next_page_token as a value for the page_token parameter in the next ListClusters request. Subsequent ListClusters requests will have their own next_page_token to continue paging through the results.

SupportJob​

Data Proc support job.

Status​
  • STATUS_UNSPECIFIED

  • PROVISIONING

    Job created in metadb and is waiting agent to acquire.

  • PENDING

    Job acquired by agent and is waiting for execution.

  • RUNNING

    Job is running.

  • ERROR

    Job failed.

  • DONE

    Job finished.

  • CANCELLED

    Job cancelled.

  • CANCELLING

    Job is waiting for cancellation.

id : string​

Required. Unique ID of the Data Proc job. This ID is assigned by MDB in the process of creating Data Proc job.

clusterId : string​

Required. Unique ID of the Data Proc cluster.

createdAt : google.protobuf.Timestamp​

The time when the Data Proc job was created.

startedAt : google.protobuf.Timestamp​

The time when the Data Proc job was started.

finishedAt : google.protobuf.Timestamp​

The time when the Data Proc job was finished.

status : Status​

Status.

cmd : string​

Command.

timeout : int64​

Execution timeout in seconds.

createdBy : string​

The id of the user who created the job