Get Partitions for a Tape Link
The Get Partitions for a Tape Link operation lists the partitions to which the tape link with the given identifier is attached.
HTTP method and URI
GET /api/tape-links/{tape-link-id}/operations/get-partitions
In this request, the URI variable {tape-link-id} is the object-id of the Tape Link object.
Query parameters
Name | Type | Req/Opt | Description |
---|---|---|---|
name | String | Optional | Filter pattern (regular expression) to limit returned Partition objects to those that have a matching name property |
status | String Enum | Optional |
Optional filter string to limit returned Partition objects to those that have a matching status property. Value must be a valid partition status property value. |
Response body contents
On successful completion, the response body contains a JSON object with the following fields:Field name | Type | Description |
---|---|---|
partitions | Array of partition-info objects | Array of partition-info objects, described in the next table. The returned array may be empty. |
Each nested partition-info object contains the following fields:
Field name | Type | Description |
---|---|---|
object-uri | String/ URI | The canonical URI path (object-uri) of the Partition object. This property will be null when the current user has no object access permission to the partition. |
name | String | The name property of the Partition object. |
status | String Enum | The status property of the Partition object. |
Description
This operation lists the partitions to which the identified tape link is attached. The object URI, name and status are provided for each.
If the object ID {tape-link-id} does not identify a tape link object to which the API user has object-access permission, a 404 (Not Found) status code is returned.
If the name query parameter is specified, the returned list is limited to those partitions that have a name property matching the specified filter pattern. If the name parameter is omitted, this filtering is not done.
If the status query parameter is specified, the parameter is validated to ensure it is a valid value for the status property according to the Partition object data model. If the value is not valid, a 400 (Bad Request) is returned. If the value is valid, the returned list is limited to those partitions that have the specified status value. If the status parameter is omitted, this filtering is not done.
The operation lists all partitions attached to the tape link including partitions the current user may not have object access permission to. For partitions without object access permission, the object-uri property will be null. If no partitions are to be included in the results due to filtering, an empty list is provided and the operation completes successfully.
Authorization requirements
- Object-access permission to the tape link whose object-id is {tape-link-id}.
HTTP status and reason codes
On success, the HTTP status code 200 (OK) is returned and the response body is provided as described in the Response body contents.
Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body providing the reason code indicated and associated error message.
HTTP error status code | Reason code | Description |
---|---|---|
400 (Bad Request) | Various | Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes. |
14 | A query parameter defines an invalid value. | |
404 (Not Found) | 1 | A tape link with object-id {tape-link-id} does not exist on the Console or the API user does not have object-access permission to it. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.