Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2019-06-202346811.1 MB
Service

Gets the description of an existing Service Fabric service.

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

get/Services/{serviceId}/$/GetDescription

Path parameters

serviceIdstring required

The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from 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 "myappapp1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

Query parameters

api-version'6.0' required

The version of the API. This parameter is required and its value must be '6.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

timeoutinteger

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Response

A successful operation will return 200 status code.

ServiceKind'Invalid' | 'Stateless' | 'Stateful' required

The kind of service (Stateless or Stateful).

ApplicationNamestring

The name of the application, including the 'fabric:' URI scheme.

ServiceNamestring required

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

ServiceTypeNamestring required

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

InitializationDatainteger[]

Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.

PlacementConstraintsstring

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)".

DefaultMoveCost'Zero' | 'Low' | 'Medium' | 'High'

Specifies the move cost for the service.

IsDefaultMoveCostSpecifiedboolean

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.

ServiceDnsNamestring

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.