Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Application

Gets the information about an application deployed on a Service Fabric node.

This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.

get/Nodes/{nodeName}/$/GetApplications/{applicationId}

Path parameters

nodeNamestring required

The name of the node.

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 "myappapp1" in 6.0+ and "myapp/app1" in previous versions.

Query parameters

api-version'6.1' required

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

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.

IncludeHealthStateboolean

Include the health state of an entity. If this parameter is false or not specified, then the health state returned is "Unknown". When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time.

Response

A successful operation will return 200 status code and the information about the deployed 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.

Status'Invalid' | 'Downloading' | 'Activating' | 'Active' | 'Upgrading' | 'Deactivating'

The status of the application deployed on the node. Following are the possible values.

WorkDirectorystring

The work directory of the application on the node. The work directory can be used to store application data.

LogDirectorystring

The log directory of the application on the node. The log directory can be used to store application logs.

TempDirectorystring

The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.

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

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