Sign in

v2

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

Gets the list of code packages deployed on a Service Fabric node.

Gets the list of code packages deployed on a Service Fabric node for the given application.

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

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

ServiceManifestNamestring

The name of a service manifest registered as part of an application type in a Service Fabric cluster.

CodePackageNamestring

The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.

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 and the list of deployed code packages information.

Namestring

The name of the code package defined in the service manifest.

Versionstring

The version of the code package specified in service manifest.

ServiceManifestNamestring

The name of the service manifest.

ServicePackageActivationIdstring

The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.

HostType'Invalid' | 'ExeHost' | 'ContainerHost'

Specifies the type of host for main entry point of a code package as specified in service manifest.

HostIsolationMode'None' | 'Process' | 'HyperV'

Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.

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

Specifies the status of a deployed application or service package on a Service Fabric node.

RunFrequencyIntervalstring

The interval at which code package is run. This is used for periodic code package.