Service

Detailed description of a PaaS service.

Contents

• availableEnvironmentVersions — The environment versions to which the current version can be updated.

  • Type: Array of strings

• backupSettings — Backup settings for the service.

  • Type: BackupSettingsResponse object

• databases — List of databases.

  • Type: List of DatabaseResponse objects

• dataVolumeIops— Number of read/write operations per second for data volume.

  • Type: Integer

• dataVolumeSize — The size of the data volume.

  • Type: Integer

• dataVolumeType — The type of the data volume.

  • Type: String

• endpoints — List of endpoints for connecting to the service.

  • Type: Array of strings

• environmentVersion — The current version of the service environment.

  • Type: String

• errorCode — Error code for creating the service.

  • Type: String

• errorDescription — Detailed description of service creation error.

  • Type: String

• externalBalancerAllowed — Indicates whether an internet-facing load balancer is available for the service.

  • Type: Boolean

• externalBalancerRequired— Indicates whether to create an internet-facing load balancer.

  • Type: Boolean

• externalBalancerTargets — The target resources to create internet-facing load balancers.

  • Type: List of LoadBalancerTarget objects

• highAvailability— Indicates whether to start a high-availability service.

  • Type: Boolean

• id — The service ID.

  • Type: String

• instanceQty — The number of instances.

  • Type: Integer

• instances — List of instances that refers to the service.

  • Type: List of Instance objects

• instanceType — The instance type.

  • Type: String

• internalBalancerAllowed — Indicates whether an internal load balancer is available for the service.

  • Type: Boolean

• internalBalancerRequired— Indicates whether to create an internal load balancer.

  • Type: Boolean

• internalBalancerTargets — The target resources to create internal load balancers.

  • Type: List of LoadBalancerTarget objects

• isRolledBack — Indicates whether the service irolls back to its previous state.

  • Type: Boolean

• loadBalancers — The load balancers created for the service.

  • Type: List of ServiceLoadBalancers objects

• name — The service name.

  • Type: String

• networkInterfaceIds — List of network interface IDs.

  • Type: Array of strings

• parameters — Service parameters.

  • Type: Dict

  • Valid values: Depend on service type (see PaaS Parameters)

• rootVolumeIops— Number of read/write operations per second for the instance boot volume.

  • Type: Integer

• rootVolumeSize — The size of the instance boot volume.

  • Type: Integer

• rootVolumeType — The type of the instance boot volume.

  • Type: String

• securityGroups — List of security groups.

  • Type: List of SecurityGroup objects

• serviceClass — The service class.

  • Type: String

• serviceType — The service type.

  • Type: String

• sshKeyName — The name of the SSH key for accessing instances.

  • Type: String

• status — The current status of the service.

  • Type: String

• subnetIds — List of subnet IDs.

  • Type: Array of strings

• supportedFeatures — List of service features.

  • Type: Array of strings

• totalCpuCount — Total number of CPU cores in use.

  • Type: Integer

• totalMemory — Total RAM in use.

  • Type: Integer

• users — User list.

  • Type: List of UserResponse objects

• vpcId — The ID of the VPC.

  • Type: String