/scalemgmt/v3/operations: GET

Lists information about all long-running operations (LROs).

Availability

Available on all IBM Storage Scale editions.

Description

The GET operations request lists information about all LROs. The number of operations varies based on cluster administration activity and the age of completed jobs. Jobs older than a predetermined age are automatically removed, along with their metadata and related artifacts. Also, when the number of operations reaches a predefined limit, the oldest completed jobs (DONE state) are removed.

To control the number of operations displayed, specify a page size. The number of displayed operations won’t exceed the specified value. To retrieve the next page of operations, submit a page token with the next list request. The request returns the next set of operations, up to the specified page size. To run this request, you must have the RBAC permission for the list action on the /scalemgmt/v3/operations resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/operations

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
page_size The number of items to list per request to the API. Required.
page_token The page token is received from previous LRO list call to provide this to retrieve the subsequent page. Optional.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "next_page_token": "string",
  "operations": [
    {
      "done": true,
      "error": {
        "details": [
          {
            "@type": "string",
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        ],
        "httpcode": 0,
        "message": "string",
        "status": "CANCELLED"
      },
      "metadata": {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "name": "string",
      "response": {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ]
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example gets information about all LROs:

Request data: 
curl  -n -k -X GET  https://localhost:46443/scalemgmt/v3/operations
Response data: 
{
  "operations": [
    {
      "name": "MTo4Y2MxNjQyZi01YjZkLTQyNzQtYmE1My0yYjgyZmY3MjAxMzk=",
      "metadata": {
        "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
        "job_id": "MTo4Y2MxNjQyZi01YjZkLTQyNzQtYmE1My0yYjgyZmY3MjAxMzk=",
        "operation_details": {
          "@type": "type.googleapis.com/nsd.v3.BatchCreateNSDsRequest",
          "requests": [
            {
              "name": "nsd_2",
              "nsd_servers": ["arwen-21"],
              "device_name": "/dev/vdc"
            },
            {
              "name": "nsd_3",
              "nsd_servers": ["arwen-21"],
              "device_name": "/dev/vdd"
            }
          ]
        },
        "status": "DONE",
        "request_time": "2025-03-31T19:58:56.355575530Z",
        "completion_time": "2025-03-31T19:58:58.139853996Z",
        "last_update_time": "2025-03-31T19:58:58.139853996Z",
        "domain_ids": [0]
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/nsd.v3.BatchCreateNSDsResponse",
        "succeeded": [
          {
            "nsd": {
              "name": "nsd_2",
              "volume_id": "0A00641167EAF400",
              "nsd_servers": ["arwen-21.openstacklocal"],
              "size": "4294967296",
              "dev_type": "SUBTYPE_GENERIC_DISK",
              "device_name": "/dev/vdc",
              "failure_group": "-1",
              "storage_pool": "system",
              "disk_subtype": "SUBTYPE_OTHER_DISK"
            }
          },
          {
            "nsd": {
              "name": "nsd_3",
              "volume_id": "0A00641167EAF401",
              "nsd_servers": ["arwen-21.openstacklocal"],
              "size": "4294967296",
              "dev_type": "SUBTYPE_GENERIC_DISK",
              "device_name": "/dev/vdd",
              "failure_group": "-1",
              "storage_pool": "system",
              "disk_subtype": "SUBTYPE_OTHER_DISK"
            }
          }
        ]
      }
    },
    {
      "name": "MTo4MWYwMzdkOS03YTFjLTQ0ZDItYjdmOS1hMGFkMTc1MzQ3YmM=",
      "metadata": {
        "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
        "job_id": "MTo4MWYwMzdkOS03YTFjLTQ0ZDItYjdmOS1hMGFkMTc1MzQ3YmM=",
        "operation_details": {
          "@type": "type.googleapis.com/nsd.v3.BatchDeleteNSDsRequest",
          "nsd_names": ["nsd_2", "nsd_3"]
        },
        "status": "DONE",
        "request_time": "2025-03-31T20:15:11.661660105Z",
        "completion_time": "2025-03-31T20:15:14.787703454Z",
        "last_update_time": "2025-03-31T20:15:14.787703454Z",
        "domain_ids": [0]
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/nsd.v3.BatchDeleteNSDsResponse",
        "succeeded": [
          { "nsd_name": "nsd_3" },
          { "nsd_name": "nsd_2" }
        ]
      }
    }
  ]
}