pem.APS.getServiceInstances

This method is supported by Operations starting from version 5.4.4.

This method returns a list of Application Service Instances of the specified Application Instance.

The method has the following input parameters:

Name

Type

Short Description

application_instance_id

int

Application Instance ID

service_id

string

Application Service ID.

The Application Service ID of the required Application Service can be obtained in the following ways:

Note: If the empty string is specified in the service_id parameter, the method returns information about all existing Application Service Instances.

The method returns an array of the following structures:

Name

Type

Short Description

service_instance_id

int

Application Service Instance ID

service_id

string

Application Service ID

service_instance_status

string

The current status of the Application Service Instance. There are the following options:

  • Provisioning – Application Instance is being installed.
  • Provisioning Service – Application Service Instance is being installed.
  • Ready – Application Instance is installed.
  • Backing Up – 'Backup' operation for the Application Instance is in progress.
  • Restoring – 'Restore' operation for the Application Instance is in progress.
  • Configuring Service – Application Service Instance is being configured.
  • Upgrading – 'Upgrade' operation for the Application Instance is in progress.
  • Disabling – 'Disable' operation for the Application Service Instance is in progress.
  • Disabled – Application Instance is disabled.
  • Enabling Service – 'Enable' operation for the Application Service Instance is in progress.
  • Unprovisioning Service – Application Service Instance is being uninstalled.
  • Unprovisioning – Application Instance is being uninstalled.

parent_service_instance_id

int

The identifier of the parent Application Service Instance.

resource_type_id

int

Resource Type ID of the corresponding 'Application Service' Resource Type. If there is no any 'Application Service' Resource Type for the Application Service Instance, the 0 value is returned.

settings

array of struct

Settings of the Application Service Instance

  • name

string

Name of a setting

  • value

string

Value of a setting

Note: This method can also be called under Reseller permissions.