/scalemgmt/v3/operations/{id}: GET

Lists details of the LRO for the specified ID.

Availability

Available on all IBM Storage Scale editions.

Description

The GET operations/{id} request lists details of an existing LRO. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/operations resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/operations/{id}
where
{id}
Specifies the operation ID of the LRO.

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
id The operation ID of the LRO. Required.
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.
    {
  "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 lists information about the LRO for the MTo4MWYwMzdkOS03YTFjLTQ0ZDItYjdmOS1hMGFkMTc1MzQ3YmM= ID:

Request data: 
curl  -n -k -X GET  https://localhost:46443/scalemgmt/v3/operations/MTo4MWYwMzdkOS03YTFjLTQ0ZDItYjdmOS1hMGFkMTc1MzQ3YmM=
Response data: 
{
  "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"
      }
    ]
  }
}