This APS type represents a service attached to service nodes (also known as hosts).
In this document:
The considered APS type (download
)
extends the Resource APS type(s) and looks as follows:
{
"name": "HostService",
"id": "http://www.parallels.com/pa/pa-core-services/host-management/HostService/1.0",
"apsVersion": "2.0",
"implements": [
"http://aps-standard.org/types/core/resource/1.0"
],
"relations": {
"subscription": {
"type": "http://aps-standard.org/types/core/subscription/1.0"
}
},
"properties": {
"hosts": {
"type": "array",
"description": "Service hosts",
"items": {
"type": "string"
}
},
"serviceName": {
"type": "string",
"description": "Service name",
"required": true
},
"serviceDescription": {
"type": "string",
"description": "Service description",
"required": true
}
}
}
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/host-services?<RQL-filter>
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
---|---|---|---|---|
hosts |
Array of String |
Not Required |
A list of the service nodes the service is attached to. |
|
serviceName |
String |
Required |
Name of the service. |
|
serviceDescription |
String |
Required |
Description of the service. |
NAME |
TYPE |
REQUIRED |
DESCRIPTION |
---|---|---|---|
subscription |
No |
Relationship with the subscription. |