ConfigurationManager

Configuration Manager provides a custom opertaion to get some system properties. Used to get system properties

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "ConfigurationManager",
  "id": "http://www.parallels.com/pa/pa-core-services/configuration-manager/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "getSystemProperty": {
      "path": "systemProperty",
      "verb": "GET",
      "response": {
        "type": "ParameterValue"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "name": {
          "kind": "query",
          "type": "string"
        },
        "account_id": {
          "kind": "query",
          "type": "integer"
        }
      }
    }
  },
  "structures": {
    "ParameterValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "BOOL",
            "NUM",
            "ENUM",
            "STR"
          ]
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
getSystemProperty	GET	systemProperty	If successful, this method returns a ParameterValue object in the response body.	Get the specified system property.

getSystemProperty

HTTP Request

GET /aps/2/resources/{aps-id}/systemProperty

Description

Get the specified system property.

Parameters

PARAMETER	TYPE	DESCRIPTION
account_id	Integer	Account identifier in the platform.
name	String	Property name

Returns

If successful, this method returns a ParameterValue object in the response body.

Structures

ParameterValue

The structure contains a list of property name and value pairs.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
type		Not Required		The property type - {“BOOL”, “NUM”, “ENUM”, “STR”}.
value	String	Not Required		The property value.

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Configuration Management

Resource Management →