StatefulServiceInfo

  • Article

Information about a stateful Service Fabric service.

Properties

Name Type Required
Id string No
Name string No
TypeName string No
ManifestVersion string No
HealthState string (enum) No
ServiceStatus string (enum) No
IsServiceGroup boolean No
ServiceMetadata ServiceMetadata No
HasPersistedState boolean No

Id

Type: string
Required: No

The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Name

Type: string
Required: No

The full name of the service with 'fabric:' URI scheme.

TypeName

Type: string
Required: No

Name of the service type as specified in the service manifest.

ManifestVersion

Type: string
Required: No

The version of the service manifest.

HealthState

Type: string (enum)
Required: No

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

Possible values are:

  • Invalid - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ok - Indicates the health state is okay. The value is 1.
  • Warning - Indicates the health state is at a warning level. The value is 2.
  • Error - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
  • Unknown - Indicates an unknown health status. The value is 65535.

ServiceStatus

Type: string (enum)
Required: No

The status of the application.

Possible values are:

  • Unknown - Indicates the service status is unknown. The value is zero.
  • Active - Indicates the service status is active. The value is 1.
  • Upgrading - Indicates the service is upgrading. The value is 2.
  • Deleting - Indicates the service is being deleted. The value is 3.
  • Creating - Indicates the service is being created. The value is 4.
  • Failed - Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5.

IsServiceGroup

Type: boolean
Required: No

Whether the service is in a service group.

ServiceMetadata

Type: ServiceMetadata
Required: No

Metadata associated with a specific service.

HasPersistedState

Type: boolean
Required: No

Whether the service has persisted state.