The type is used to manage service nodes (also known as hosts) registered in the platform. It implements the APS core Resource type.
In this document:
The considered APS type (download
)
extends the Resource APS type(s) and looks as follows:
{
"name": "Host",
"id": "http://www.parallels.com/pa/pa-core-services/host-management/Host/1.1",
"apsVersion": "2.0",
"implements": [
"http://aps-standard.org/types/core/resource/1.0"
],
"relations": {
"capacities": {
"type": "http://www.parallels.com/pa/pa-core-services/host-management/Capacity/1.0",
"collection": true
}
},
"properties": {
"backnetIp": {
"type": "string",
"description": "IP for access to host"
},
"platform": {
"type": "Platform"
},
"hostId": {
"type": "integer"
},
"provisioningStatus": {
"type": "string",
"required": true,
"enum": [
"READY",
"NOT_READY",
"RESTRICTED"
]
},
"currentCapacities": {
"type": "array",
"items": {
"type": "http://www.parallels.com/pa/pa-core-services/host-management/Capacity/1.0"
}
},
"hostType": {
"type": "string",
"default": "H_NODE",
"enum": [
"H_HW_NODE",
"H_NODE",
"H_VE",
"H_ANY",
"H_WIN",
"H_CL_NODE",
"H_H2E",
"H_H2E_WS_CLUSTER",
"H_H2E_WS_STANDALONE",
"H_K8S_UI_CLUSTER"
]
}
},
"structures": {
"Platform": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
}
}
The APS type is used to manage a collection of APS resources. To get a list of resources from that collection, use the following API call:
GET /aps/2/collections/hosts?<RQL-filter>
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
---|---|---|---|---|
backnetIp |
String |
Not Required |
IP address on the BackNet interface available for the management node. |
|
platform |
Not Required |
The structure containing the properties of the Operating System installed on the host. |
||
hostId |
Integer |
Not Required |
The platform internal host ID. |
|
provisioningStatus |
Enum |
Required |
Identifies the provisioning status of the Host.
Host provisioning status:
READY - host is ready for provisioning.NOT_READY - host is not ready for provisioning.RESTRICTED - host is restricted for provisioning. |
|
currentCapacities |
Array of Capacity |
Not Required |
A list of current host capacities. |
|
hostType |
Enum |
Not Required |
H_NODE |
Get type of the host. |
NAME |
TYPE |
REQUIRED |
DESCRIPTION |
---|---|---|---|
capacities |
Collection of Capacity |
No |
A list of capacities bound to the host through the capacities link. (“”http://www.parallels.com/pa/pa-core-services/host-management/Capacity/1.0”) Capacities is an optional collection of links with the resources based on the Capacity type. |
Properties of the Operating System on the Host.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
---|---|---|---|---|
name |
String |
Not Required |
OS name. |
|
version |
String |
Not Required |
OS version. |