ListOperations

Lists operations for the specified dashboard.

TypeScript

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

const ListDashboardOperationsRequest =
  cloudApi.monitoring.dashboard_service.ListDashboardOperationsRequest;

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

  const result = await client.listOperations(
    ListDashboardOperationsRequest.fromPartial({
      dashboardId: "dashboardId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.monitoring.v3.dashboard_service_pb2_grpc import DashboardServiceStub
from yandex.cloud.monitoring.v3.dashboard_service_pb2 import ListDashboardOperationsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(DashboardServiceStub)
response = service.ListOperations(
    ListDashboardOperationsRequest(
        dashboard_id="dashboardId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListDashboardOperationsRequest

dashboardId : string

ID of the dashboard to list operations for.

pageSize : int64

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDashboardOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : string

Page token. To get the next page of results, set page_token to the ListDashboardOperationsResponse.next_page_token returned by a previous list request.

ListDashboardOperationsResponse

operations : operation.Operation

List of operations for the specified dashboard.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListDashboardOperationsRequest.page_size, use the next_page_token as the value for the ListDashboardOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  The normal response of the operation in case of success.

  If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

---