{
"opencollection": "1.0.0",
"info": {
"name": "Microsoft Azure AccessControlClient AccessConnector Faults API",
"version": "2020-08-01-preview"
},
"items": [
{
"info": {
"name": "Faults",
"type": "folder"
},
"items": [
{
"info": {
"name": "Microsoft Azure This Api Will Induce Data Loss For The Specified Partition It Will Trigger A Call To The Ondatalossasync Api Of The Partition",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartDataLoss",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"name": "DataLossMode",
"value": "",
"type": "query",
"description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce."
},
{
"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": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.
Actual data loss will depend on the specified DataLossMode.
- PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.
- FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.
This API should only be call"
},
{
"info": {
"name": "Microsoft Azure Gets The Progress Of A Partition Data Loss Operation Started Using The Startdataloss Api",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetDataLossProgress",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"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 progress of a data loss operation started with StartDataLoss, using the OperationId."
},
{
"info": {
"name": "Microsoft Azure Induces Quorum Loss For A Given Stateful Service Partition",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartQuorumLoss",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"name": "QuorumLossMode",
"value": "",
"type": "query",
"description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce."
},
{
"name": "QuorumLossDuration",
"value": "",
"type": "query",
"description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds."
},
{
"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": "This API is useful for a temporary quorum loss situation on your service.
Call the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.
This can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services."
},
{
"info": {
"name": "Microsoft Azure Gets The Progress Of A Quorum Loss Operation On A Partition Started Using The Startquorumloss Api",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetQuorumLossProgress",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"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 progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId."
},
{
"info": {
"name": "Microsoft Azure This Api Will Restart Some Or All Replicas Or Instances Of The Specified Partition",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/StartRestart",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"name": "RestartPartitionMode",
"value": "",
"type": "query",
"description": "Describe which partitions to restart."
},
{
"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": "This API is useful for testing failover.
If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.
Call the GetPartitionRestartProgress API using the same OperationId to get the progress."
},
{
"info": {
"name": "Microsoft Azure Gets The Progress Of A Partitionrestart Operation Started Using Startpartitionrestart",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Faults/Services/:serviceId/$/GetPartitions/:partitionId/$/GetRestartProgress",
"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": "serviceId",
"value": "",
"type": "path",
"description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions."
},
{
"name": "partitionId",
"value": "",
"type": "path",
"description": "The identity of the partition."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"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 progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId."
},
{
"info": {
"name": "Microsoft Azure Starts Or Stops A Cluster Node",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/Faults/Nodes/:nodeName/$/StartTransition/",
"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": "nodeName",
"value": "",
"type": "path",
"description": "The name of the node."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"name": "NodeTransitionType",
"value": "",
"type": "query",
"description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up."
},
{
"name": "NodeInstanceId",
"value": "",
"type": "query",
"description": "The node instance ID of the target node. This can be determined through GetNodeInfo API."
},
{
"name": "StopDurationInSeconds",
"value": "",
"type": "query",
"description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up."
},
{
"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": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.
To stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.
Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation."
},
{
"info": {
"name": "Microsoft Azure Gets The Progress Of An Operation Started Using Startnodetransition",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Faults/Nodes/:nodeName/$/GetTransitionProgress",
"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": "nodeName",
"value": "",
"type": "path",
"description": "The name of the node."
},
{
"name": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"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 progress of an operation started with StartNodeTransition using the provided OperationId."
},
{
"info": {
"name": "Microsoft Azure Gets A List Of User Induced Fault Operations Filtered By Provided Input",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/Faults/",
"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": "TypeFilter",
"value": "",
"type": "query",
"description": "Used to filter on OperationType for user-induced operations.\n\n- 65535 - select all\n- 1 - select PartitionDataLoss.\n- 2 - select PartitionQuorumLoss.\n- 4 - select PartitionRestart.\n- 8 - select NodeTransition."
},
{
"name": "StateFilter",
"value": "",
"type": "query",
"description": "Used to filter on OperationState's for user-induced operations.\n\n- 65535 - select All\n- 1 - select Running\n- 2 - select RollingBack\n- 8 - select Completed\n- 16 - select Faulted\n- 32 - select Cancelled\n- 64 - select ForceCancelled"
},
{
"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 list of user-induced fault operations filtered by provided input."
},
{
"info": {
"name": "Microsoft Azure Cancels A User Induced Fault Operation",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/Faults/$/Cancel",
"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": "OperationId",
"value": "",
"type": "query",
"description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API"
},
{
"name": "Force",
"value": "",
"type": "query",
"description": "Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation."
},
{
"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": "The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.
If force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state
may be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has a"
}
]
}
],
"bundled": true
}