Get Deployed Service Type Info List
Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.
Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.
Request
| Method | Request URI |
|---|---|
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes?api-version=6.0&ServiceManifestName={ServiceManifestName}&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
nodeName |
string | Yes | Path |
applicationId |
string | Yes | Path |
api-version |
string | Yes | Query |
ServiceManifestName |
string | No | Query |
timeout |
integer (int64) | No | Query |
nodeName
Type: string
Required: Yes
The name of the node.
applicationId
Type: string
Required: Yes
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.
api-version
Type: string
Required: Yes
Default: 6.0
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.
ServiceManifestName
Type: string
Required: No
The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest.
timeout
Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
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.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 200 (OK) | List of information about service types of an application deployed on a node. |
array of DeployedServiceTypeInfo |
| All other status codes | The detailed error response. |
FabricError |