Sign in

v2

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

Invoke container API on a container deployed on a Service Fabric node.

Invoke container API on a container deployed on a Service Fabric node for the given code package.

post/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi

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.2' required

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

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 version 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 accepts 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 and the runtime is 6.1, 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 required

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

CodePackageNamestring required

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

CodePackageInstanceIdstring required

ID that uniquely identifies a code package instance deployed on a service fabric node.

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.

Request body

HttpVerbstring

HTTP verb of container REST API, defaults to "GET"

UriPathstring required

URI path of container REST API

Content-Typestring

Content type of container REST API request, defaults to "application/json"

Bodystring

HTTP request body of container REST API

Response

A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.