Start of change

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 and tenants 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

Table 1. z/OSMF resource management services: operations summary
Operation name HTTP method and URI path
Get a domain
GET /zosmf/resource-mgmt/rest/<version>/domains/<object-id>
List the domains
GET /zosmf/resource-mgmt/rest/<version>/domains/
Get a tenant
GET /zosmf/resource-mgmt/rest/<version>/tenants/<object-id>
List the tenants
GET /zosmf/resource-mgmt/rest/<version>/tenants/

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 landlord 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 IBM z/OS Management Facility Configuration Guide. .

HTTP status codes

The following HTTP status codes are valid:
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 404 Not found
The requested resource does not exist.
HTTP 500 Server error
The server encountered an error when it processed the request.
End of change