Resource management services
The resource management services are an application programming interface (API), which is implemented through industry standard Representational State Transfer (REST) services. These services allow the caller to get and list domains, tenants, and resource pools that were defined in support of IBM Cloud Provisioning and Management for z/OS.
Table 1 lists the operations that the resource management services provide.
Resource management services
| Operation name | HTTP method and URI path |
|---|---|
| Get a domain |
|
| Get a domain history |
|
| List the domains |
|
| Create a tenant |
|
| Get a tenant |
|
| Get a tenant history |
|
| List the tenants |
|
| Delete a tenant |
|
| Assign CPU properties to a tenant |
|
| Assign memory capping properties to a tenant |
|
| Assign a solution ID |
|
| Disable CPU capping |
|
| Disable memory capping |
|
| Disable metering |
|
| Enable CPU capping |
|
| Enable memory capping |
|
| Enable metering |
|
| Add tenant consumer |
|
| Remove tenant consumer |
|
| Add tenant description |
|
| Add tenant groups |
|
| Remove tenant groups |
|
| Get a resource pool |
|
| Get a domain resource pool |
|
| Get a resource pool history |
|
| List the resource pools |
|
| List domain resource pools |
|
 List template resource pools |
|
| Update the security state for a tenant |
|
| Get security resources |
|
Authorization requirements
Use of the Resource Management services API requires the client to be authenticated. For information about client authentication in z/OSMF, see Authenticating to z/OSMF.
In addition, the user’s z/OS® user ID may need access to other resources, including those that define roles such as the provisioning administrator and domain administrator. The specific requirements for each resource management service are described in the topic for that service. For an overview of the security requirements for cloud provisioning roles, see Authorization requirements. For details, see Steps for setting up security in IBM z/OS Management Facility Configuration Guide.
HTTP status codes
- HTTP 200 OK
- The request succeeded. A response body is provided, which contains the results of the request.
- HTTP 400 Bad request
- There is a missing field in the request body.
- HTTP 401 Not authorized
- The request cannot be processed because the client is not authorized.
- HTTP 403 Cannot access
- The client does not have access rights to the content (they are not authorized). As a result, the server is not returning the expected.
- HTTP 404 Not found
- The requested resource does not exist.
- HTTP 409 Conflict
- The request cannot be processed because of conflict in the request, such as an edit conflict between multiple updates.
- HTTP 500 Server error
- The server encountered an error when it processed the request.