---
title: "Gets the description of an existing Service Fabric service."
method: GET
path: "/Services/{serviceId}/$/GetDescription"
tags: ["Service"]
---

# Gets the description of an existing Service Fabric service.

`GET /Services/{serviceId}/$/GetDescription`

Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.

## Path parameters

- `serviceId` string, required

## Query parameters

- `api-version` '6.0', required
- `timeout` integer

## Response `200`

A successful operation will return 200 status code.

- ServiceDescription — A ServiceDescription contains all of the information necessary to create a service.
  - `ServiceKind` 'Invalid' | 'Stateless' | 'Stateful', required — The kind of service (Stateless or Stateful).
  - `ApplicationName` string — The name of the application, including the 'fabric:' URI scheme.
  - `ServiceName` string, required — The full name of the service with 'fabric:' URI scheme.
  - `ServiceTypeName` string, required — Name of the service type as specified in the service manifest.
  - `InitializationData` integer[] — Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.
  - `PartitionDescription` PartitionSchemeDescription, required — Describes how the service is partitioned.
    - `PartitionScheme` 'Invalid' | 'Singleton' | 'UniformInt64Range' | 'Named', required — Enumerates the ways that a service can be partitioned.
  - `PlacementConstraints` string — The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
  - `CorrelationScheme` ServiceCorrelationDescription[] — A list that describes the correlation of the service with other services.
    - `Scheme` 'Invalid' | 'Affinity' | 'AlignedAffinity' | 'NonAlignedAffinity', required — The service correlation scheme.
    - `ServiceName` string, required — The full name of the service with 'fabric:' URI scheme.
  - `ServiceLoadMetrics` ServiceLoadMetricDescription[] — The service load metrics is given as an array of ServiceLoadMetricDescription objects.
    - `Name` string, required — The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive.
    - `Weight` 'Zero' | 'Low' | 'Medium' | 'High' — Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.
    - `PrimaryDefaultLoad` integer — Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
    - `SecondaryDefaultLoad` integer — Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
    - `AuxiliaryDefaultLoad` integer — Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is an Auxiliary replica.
    - `DefaultLoad` integer — Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
  - `ServicePlacementPolicies` ServicePlacementPolicyDescription[] — A list that describes the correlation of the service with other services.
    - `Type` 'Invalid' | 'InvalidDomain' | 'RequireDomain' | 'PreferPrimaryDomain' | 'RequireDomainDistribution' | 'NonPartiallyPlaceService' | 'AllowMultipleStatelessInstancesOnNode', required — The type of placement policy for a service fabric service. Following are the possible values.
  - `DefaultMoveCost` 'Zero' | 'Low' | 'Medium' | 'High' | 'VeryHigh' — Specifies the move cost for the service.
  - `IsDefaultMoveCostSpecified` boolean — Indicates if the DefaultMoveCost property is specified.
  - `ServicePackageActivationMode` 'SharedProcess' | 'ExclusiveProcess' — The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.
  - `ServiceDnsName` string — The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
  - `ScalingPolicies` ScalingPolicyDescription[] — A list that describes the scaling policies.
    - `ScalingTrigger` ScalingTriggerDescription, required — Describes the trigger for performing a scaling operation.
      - `Kind` 'Invalid' | 'AveragePartitionLoad' | 'AverageServiceLoad', required — Enumerates the ways that a service can be scaled.
    - `ScalingMechanism` ScalingMechanismDescription, required — Describes the mechanism for performing a scaling operation.
      - `Kind` 'Invalid' | 'PartitionInstanceCount' | 'AddRemoveIncrementalNamedPartition', required — Enumerates the ways that a service can be scaled.
  - `TagsRequiredToPlace` NodeTagsDescription — Describes the tags required for placement or running of the service.
    - `Count` integer, required — The number of tags.
    - `Tags` string[], required — Array of size specified by the ‘Count’ parameter, for the placement tags of the service.
  - `TagsRequiredToRun` NodeTagsDescription — Describes the tags required for placement or running of the service.
    - `Count` integer, required — The number of tags.
    - `Tags` string[], required — Array of size specified by the ‘Count’ parameter, for the placement tags of the service.

## Other responses

- `default` — The detailed error response.

---

[API](https://skmtc.net/azure/apis/servicefabric-servicefabric.md) · [All operations](https://skmtc.net/azure/apis/servicefabric-servicefabric/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/servicefabric-servicefabric/revisions/8fd479ce0f16/schema)