{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Chaos API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Chaos", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get The Status Of Chaos", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Tools/Chaos", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService 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.\n\nAdditionally 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." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule." }, { "info": { "name": "Microsoft Azure Starts Chaos In The Cluster", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Tools/Chaos/$/Start", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.
If Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.
Refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details." }, { "info": { "name": "Microsoft Azure Stops Chaos If It Is Running In The Cluster And Put The Chaos Schedule In A Stopped State", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Tools/Chaos/$/Stop", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService 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.\n\nAdditionally 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." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.
Once a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling." }, { "info": { "name": "Microsoft Azure Gets The Next Segment Of The Chaos Events Based On The Continuation Token Or The Time Range", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Tools/Chaos/Events", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService 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.\n\nAdditionally 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." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "StartTimeUtc", "value": "", "type": "query", "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." }, { "name": "EndTimeUtc", "value": "", "type": "query", "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range
through StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.
When there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API wit" }, { "info": { "name": "Microsoft Azure Get The Chaos Schedule Defining When And How To Run Chaos", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Tools/Chaos/Schedule", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService 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.\n\nAdditionally 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." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos." }, { "info": { "name": "Microsoft Azure Set The Schedule Used By Chaos", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Tools/Chaos/Schedule", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService 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.\n\nAdditionally 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." }, { "name": "timeout", "value": "", "type": "query", "description": "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." } ] }, "docs": "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." } ] } ], "bundled": true }