Get running jobs for a storage pool

Select

SaaS

Customer Managed

API to get jobs running to a storage pool.

Path Parameters

• storagePoolId int32 required

  Id of storage pool

Query Parameters

• jobType string

  Possible values: [All, Admin, Backup, Restore]

  Default value: All

  Type of job

• ignoreSuspendedJobs boolean

  Default value: true

  To include/exlude suspended jobs in the response

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• jobIds int64[]

{
  "jobIds": [
    0
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

GET /v4/storagepool/:storagepoolid/runningjobs    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

storagePoolId — path required

jobType — query

---AllAdminBackupRestore

ignoreSuspendedJobs — query

---truefalse

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StoragePool/:storagePoolId/runningJobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'