Enable maintenance for a storage pool

Select

SaaS

Customer Managed

API is used to enable maintenance for a storage pool. It will put the libraries associated to storage pool in maintenance mode and if the storage pool is HyperScale, then same would be applied to the nodes associated to the storage pool. When a storage pool is in maintenance, it will not be used by any upcoming jobs.

Path Parameters

• StoragePoolId int32 required

  Id of storage pool

Query Parameters

• suspendRunningJobs boolean

  Default value: true

  Suspend the jobs running to the storage pool

Responses

• 200
• 400
• 403
• 500

---

OK

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]

  Error code value

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

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]

  Error code value

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

Forbidden

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]

  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]

  Error code value

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

Loading...