Invoke Infrastructure Command

  • Article

Invokes an administrative command on the given Infrastructure Service instance.

For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific commands to a particular instance of the Infrastructure Service.

Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running.

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

Request

Method Request URI
POST /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

Parameters

Name Type Required Location
api-version string Yes Query
Command string Yes Query
ServiceId string No Query
timeout integer (int64) No Query

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.

Command

Type: string
Required: Yes

The text of the command to be invoked. The content of the command is infrastructure-specific.

ServiceId

Type: string
Required: No

The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.

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) The response from the infrastructure service. The response format is a JSON stream.
The contents of the response depend on which command was issued.
 string
All other status codes The detailed error response.
 FabricError