List Logical Partitions of CPC

The List Logical Partitions of CPC operation lists the logical partitions of a CPC. This operation is supported using the BCPii interface.

HTTP method and URI

GET /api/cpcs/{cpc-id}/logical-partitions

In this request, the URI variable {cpc-id} is the object ID of the target CPC.

Query Parameters

Name Type Rqd/Opt Description
name String Optional A regular expression used to limit returned objects to those that have a matching name property. If matches are found, the response will be an array with all objects that match. If no match is found, the response will be an empty array.

Response body contents

On successful completion, the response body contains a JSON object with the following field:

Field name Type Description
logical-partitions Array of logical-partition-info objects Array of nested logical-partition-info objects (described in the next table)

Each nested logical-partition-info object contains the following fields:

Field name Type Description
object-uri String/ URI Canonical URI path of the Logical Partition object
name String The name of the Logical Partition object
status String Enum The current status of the Logical Partition object
request-origin Boolean If true, the Logical Partition object is the same as the origin of the request. If false, the Logical Partition object is not the same as the origin of the request.
Note: This property is only returned when the BCPii interface was used for the request.
target-name String (1-17) The value that must be used on the X-API-Target-Name request header when performing an operation on this object.
Note: This property is only returned when the BCPii interface was used for the request.

Description

This operation lists the Logical Partition objects that belong to a CPC. The object URI, display name, and status are provided for each.

If the name query parameter is specified, the returned list is limited to those Logical Partition objects that have a name property matching the specified filter pattern. If the name parameter is omitted, this filtering is not done.

For the web services interface an object is only included in the list if the API user has object-access permission for that object. For the BCPii interface an object is only included in the list if the source partition has receive BCPii security controls permissions for the Logical Partition object.

On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.

If the CPC is in DPM mode, or there are no logical partitions defined to the CPC, or no logical partitions are to be included in the response due to filtering or access permissions, an empty list is provided and the operation completes successfully.

Authorization requirements

This operation has the following authorization requirements:
  • For the web services interface:
    • Object-access permission to the CPC object designated by {cpc-id}
    • Object-access permission to any Logical Partition object to be included in the result.
  • For the BCPii interface the source partition must have receive BCPii security controls permissions for the CPC object.

HTTP status and reason codes

On success, HTTP status code 200 (OK) 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 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.
299 A query parameter has an invalid syntax.
409 (Conflict) 329 The operation cannot be performed because the CPC designated by the request URI is an unmanaged CPC, which is not supported by this operation.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. List Logical Partitions of CPC: Request
GET /api/cpcs/37c6f8a9-8d5e-3e5d-8466-be79e49dd340/logical-partitions HTTP/1.1
x-api-session: 65aw2jahugn1wop51hsq0c6aldkkx773dz9ulirrvg2z853m4u
Figure 2. List Logical Partitions of CPC: Response
200 OK
server: zSeries management console API web server / 1.0
cache-control: no-cache
date: Fri, 25 Nov 2011 16:58:36 GMT
content-type: application/json;charset=UTF-8
content-length: 374
{
   "logical-partitions": [
      {
         "name": "APIVM1", 
         "object-uri": "/api/logical-partitions/c7eb8134-826e-3a71-8d1a-00d706c874e9", 
         "status": "operating"
      }, 
      {
         "name": "ZOS", 
         "object-uri": "/api/logical-partitions/458e44e1-b0c2-391b-83ff-ecfd847295bd", 
         "status": "not-operating"
      }
   ]
}