Post Chaos Schedule

  • Article

Set the schedule used by Chaos.

Chaos will automatically schedule runs based on the Chaos Schedule. The Chaos Schedule will be updated if the provided version matches the version on the server. When updating the Chaos Schedule, the version on the server is incremented by 1. The version on the server will wrap back to 0 after reaching a large number. If Chaos is running when this call is made, the call will fail.

Request

Method Request URI
POST /Tools/Chaos/Schedule?api-version=6.2&timeout={timeout}

Parameters

Name Type Required Location
api-version string Yes Query
timeout integer (int64) No Query
ChaosSchedule ChaosScheduleDescription Yes Body

api-version

Type: string
Required: Yes
Default: 6.2

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.

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.

ChaosSchedule

Type: ChaosScheduleDescription
Required: Yes

Describes the schedule used by Chaos.

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