Add Configuration Parameter Overrides

  • Article

Adds the list of configuration overrides on the specified node.

This api allows adding all existing configuration overrides on the specified node.

Request

Method Request URI
POST /Nodes/{nodeName}/$/AddConfigurationParameterOverrides?api-version=7.0&Force={Force}&timeout={timeout}

Parameters

Name Type Required Location
nodeName string Yes Path
api-version string Yes Query
Force boolean No Query
timeout integer (int64) No Query
ConfigParameterOverrideList array of ConfigParameterOverride Yes Body

nodeName

Type: string
Required: Yes

The name of the node.

api-version

Type: string
Required: Yes
Default: 7.0

The version of the API. This parameter is required and its value must be '7.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 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.

Force

Type: boolean
Required: No

Force adding configuration overrides on specified nodes.

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.

ConfigParameterOverrideList

Type: array of ConfigParameterOverride
Required: Yes

Description for adding list of configuration overrides.

Responses

HTTP Status Code Description Response Schema
200 (OK) A successful operation will return 200 status code.
All other status codes The detailed error response.
 FabricError