v2

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

Application

Gets information about a Service Fabric application.

Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.

get/Applications/{applicationId}

Path parameters

applicationIdstring required

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~~app1" in 6.0+ and "myapp/app1" 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.

ExcludeApplicationParametersboolean

The flag that specifies whether application parameters will be excluded from the result.

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

Information about the application.

Idstring

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

Namestring

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

TypeNamestring

The application type name as defined in the application manifest.

TypeVersionstring

The version of the application type as defined in the application manifest.

The status of the application.

HealthState'Invalid' | 'Ok' | 'Warning' | 'Error' | 'Unknown'

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

ApplicationDefinitionKind'Invalid' | 'ServiceFabricApplicationDescription' | 'Compose'

The mechanism used to define a Service Fabric application.