Delete Partition Link
The Delete Partition Link operation deletes the identified partition link asynchronously.
HTTP method and URI
POST /api/partition-links/{partition-link-id}/operations/delete
In this request, the URI variable {partition-link-id} is the object ID of the Partition Link object to be deleted.
Request body contents
An optional request body can be specified as a JSON object with the following fields:
Field Name | Type | Rqd/Opt | Description |
---|---|---|---|
force-detach | Boolean | Optional | An indication of whether active partitions associated with the partition link whose
object-id is {partition-link-id} are detached forcefully. If set to
true, any active partitions are forcefully detached before deleting the partition link. If
set to false and one or more active partitions are associated with the partition link, the
operation fails with status code 409 (Conflict) and reason code 100. Default: false |
Response body contents
Once the operation is accepted, the response body contains a JSON object with the following fields:
Field Name | Type | Description |
---|---|---|
job-uri |
String/ URI | URI that may be queried to retrieve status updates of the asynchronous operation on the Partition link. |
Asynchronous result description
Once the operation has completed, a job-completion notification is sent and results are available
for the asynchronous portion of this operation. These results are retrieved using the Query
Job Status
operation directed at the job URI provided in the response body.
The result document returned by the Query Job Status
operation is specified in
the description for Query Job Status. When the status of the job is
"complete", the results include a job completion status code and reason code (fields
job-status-code and job-reason-code) which are set as indicated in Job status and reason code. The
job-results field contains null when this operation is successful. When it is not
successful, the job-results field contains an object with the following fields:
Field Name | Type | Description |
---|---|---|
message |
String | The message text describing the detailed error that occurred when the operation was not successful. |
Description
This operation asynchronously deletes the designated partition link. Once the delete request is accepted, a 202 (Accepted) status code is returned and the response body contains a URI that may be queried to retrieve the status of the operation. See Query Job Status for information on how to query job status. When the operation has completed, an asynchronous result message is sent, with Job Status and Reason Codes described in Job status and reason code.
The deletion first detaches all partitions currently associated with the partition link. The partition link stays in "updating" state until all partitions have been detached successfully. Only after detaching all partitions, the partition link itself is deleted. If the detach operation for a any partition fails due to an error, the deletion of the partition link is aborted and a job status and reason code is returned describing the failure. If the API user does not have action/task permission to the Delete Partition Link task, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if the object-id {partition-link-id} does not identify a Partition Link object for which the API user has object-access permission. If the status of the partition link, the parent CPC, or any associated partition is not in a valid state, a 409 (Conflict) status code is returned. A 409 (Conflict) status code is also returned if the API user does not have object-access permission to all partitions currently associated with the partition link.
Authorization requirements
This operation has the following authorization requirement:
- Object-access permission to the partition link whose object-id is {partition-link-id}.
- Object-access permissions to all Partition objects currently connected to the partition link whose object-id is {partition-link-id}.
- Action/task permission to the Delete Partition Link task.
HTTP status and reason codes
On success, HTTP status code 204 (No Content) is returned and the response body is provided as described in Response body contents.
The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code and associated error message.
HTTP error status code | Reason code | Description |
---|---|---|
403 (Forbidden) | 1 | API user does not have the required action/task permissions. |
404 (Not Found) | 1 | The request URI does not designate a resource of an expected type or designates a resource for which the user does not have permission. |
409 (Conflict) | 1 | The operation cannot be performed because the partition link designated by the URI does not have a valid state. The valid states are "complete" and "incomplete". |
6 | The operation cannot be performed because the state of the CPC hosting the partition link is not valid to perform the operation. It must be in one of the following states: "active", "service-required", "degraded", and "exceptions". | |
8 | The operation cannot be performed because the request would result in the
object being placed into a state that is inconsistent with its data model or other requirements. The
request body contains a field whose presence or value is inconsistent with the current state of the
object or some aspect of the system, and thus a prerequisite condition or dependency would no longer
be met. For partition links of type "smc-d" or "hipersockets":
For partition links of type
"hipersockets":
|
|
100 | One or more partitions attached to the partition link designated by the {partition-link-id} parameter in the URI is in an active state. Either wait until all attached partitions go into a stopped state or retry the request with the force-detach field set to true. | |
101 | The user does not have permission to one or more partitions attached to the partition link designated by the {partition-link-id} parameter in the URI. | |
503 (Service Unavailable) | 1 | The request could not be processed because the HMC is not currently communicating with an SE needed to perform the requested operation. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.
Job status and reason code
HTTP error status code | Reason code | Description |
---|---|---|
204 (No Content) | N/A | The partition link was deleted successfully. |
409 (Conflict) | 1 | The operation cannot be performed because the partition link designated by the URI does not have a valid status. The valid states are "complete" and "incomplete". |
6 | The operation cannot be performed because the state of the CPC hosting the partition link is not valid to perform the operation. It must be in one of the following states: "active", "service-required", "degraded", and "exceptions". | |
100 | One or more partitions attached to the partition link designated by the {partition-link-id} parameter in the URI is in an active state. Either wait until all attached partitions go into a stopped state or retry the request with the force-detach field set to true. | |
102 | One or more of the partitions attached to the partition link is busy with other operations. | |
500 (Server Error) | 100 | The job failed due to an internal error. The message text describes the error reason. |
101 | Partition link delete job timed out. |