swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector Faults API
schemes:
- https
tags:
- name: Faults
paths:
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss:
post:
operationId: microsoftAzureStartdataloss
summary: Microsoft Azure This Api Will Induce Data Loss For The Specified Partition It Will Trigger A Call To The Ondatalossasync Api Of The Partition
description: '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 called with a stateful service as the target.
Calling this API with a system service as the target is not advised.
Note: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.
It will not restore data if the command has progressed far enough to cause data loss.
Call the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.'
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/DataLossModeRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'202':
description: A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress:
get:
summary: Microsoft Azure Gets The Progress Of A Partition Data Loss Operation Started Using The Startdataloss Api
description: Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.
operationId: microsoftAzureGetdatalossprogress
x-ms-examples:
Gets information about a partition data loss operation. In this case the operation has a State of Completed:
$ref: ./examples/GetDataLossProgress.json
Get information about a partition data loss operation. In this case the operation is a State of Running:
$ref: ./examples/GetDataLossProgress-Running.json
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Faults
responses:
'200':
description: Information about the progress of the partition data loss operation.
schema:
$ref: '#/definitions/PartitionDataLossProgress'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss:
post:
operationId: microsoftAzureStartquorumloss
summary: Microsoft Azure Induces Quorum Loss For A Given Stateful Service Partition
description: 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.
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/QuorumLossModeRequiredQueryParam'
- $ref: '#/parameters/QuorumLossDurationRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'202':
description: A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress:
get:
summary: Microsoft Azure Gets The Progress Of A Quorum Loss Operation On A Partition Started Using The Startquorumloss Api
description: Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.
operationId: microsoftAzureGetquorumlossprogress
x-ms-examples:
Gets information about a completed quorum loss operation:
$ref: ./examples/GetQuorumLossProgress.json
Gets information about a running quorum operation operation:
$ref: ./examples/GetQuorumLossProgress-Running.json
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Faults
responses:
'200':
description: Information about the progress of a partition quorum loss operation.
schema:
$ref: '#/definitions/PartitionQuorumLossProgress'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart:
post:
operationId: microsoftAzureStartpartitionrestart
summary: Microsoft Azure This Api Will Restart Some Or All Replicas Or Instances Of The Specified Partition
description: 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.
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/RestartPartitionModeRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'202':
description: A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress:
get:
summary: Microsoft Azure Gets The Progress Of A Partitionrestart Operation Started Using Startpartitionrestart
description: Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.
operationId: microsoftAzureGetpartitionrestartprogress
x-ms-examples:
Get information a completed PartitionRestart operation:
$ref: ./examples/GetPartitionRestartProgress.json
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ServiceIdRequiredPathParam'
- $ref: '#/parameters/PartitionIdRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Faults
responses:
'200':
description: Information about the progress of a partition restart operation.
schema:
$ref: '#/definitions/PartitionRestartProgress'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Nodes/{nodeName}/$/StartTransition/:
post:
operationId: microsoftAzureStartnodetransition
summary: Microsoft Azure Starts Or Stops A Cluster Node
description: 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.
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/NodeTransitionTypeRequiredQueryParam'
- $ref: '#/parameters/NodeInstanceIdRequiredQueryParam'
- $ref: '#/parameters/StopDurationInSecondsRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'202':
description: A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/Nodes/{nodeName}/$/GetTransitionProgress:
get:
summary: Microsoft Azure Gets The Progress Of An Operation Started Using Startnodetransition
description: Gets the progress of an operation started with StartNodeTransition using the provided OperationId.
operationId: microsoftAzureGetnodetransitionprogress
x-ms-examples:
Gets information about a completed NodeTransition operation:
$ref: ./examples/GetNodeTransitionProgress.json
Gets information about a running NodeTransition operation:
$ref: ./examples/GetNodeTransitionProgress-Running.json
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Faults
responses:
'200':
description: Information about the progress of a node transition operation.
schema:
$ref: '#/definitions/NodeTransitionProgress'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/:
get:
operationId: microsoftAzureGetfaultoperationlist
summary: Microsoft Azure Gets A List Of User Induced Fault Operations Filtered By Provided Input
description: Gets the list of user-induced fault operations filtered by provided input.
x-ms-examples:
Gets information on fault operations:
$ref: ./examples/GetFaultOperationList.json
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/TypeFilterRequiredQueryParam'
- $ref: '#/parameters/StateFilterRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'200':
description: A successful operation will return 200 status code.
schema:
$ref: '#/definitions/OperationStatusList'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Faults/$/Cancel:
post:
operationId: microsoftAzureCanceloperation
summary: Microsoft Azure Cancels A User Induced Fault Operation
description: '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 already
been called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.
Clarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the
test command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.
It will not restore the target partition''s data, if the command progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal state may be left behind.'
tags:
- Faults
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/FaultOperationIdRequiredQueryParam'
- $ref: '#/parameters/ForceRequiredQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'200':
description: A successful operation will return 200 status code.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
definitions:
PartitionRestartProgress:
description: Information about a partition restart user-induced operation.
properties:
State:
$ref: '#/definitions/OperationState'
description: The state of the operation.
RestartPartitionResult:
$ref: '#/definitions/RestartPartitionResult'
description: Represents information about an operation in a terminal state (Completed or Faulted).
FabricErrorError:
description: Error object containing error code and error message.
properties:
Code:
$ref: '#/definitions/FabricErrorCodes'
description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\""
Message:
type: string
description: Error message.
required:
- Code
OperationState:
type: string
description: The state of the operation.
enum:
- Invalid
- Running
- RollingBack
- Completed
- Faulted
- Cancelled
- ForceCancelled
x-ms-enum:
name: OperationState
modelAsString: true
values:
- value: Invalid
description: The operation state is invalid.
- value: Running
description: The operation is in progress.
- value: RollingBack
description: The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. "RollingBack" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of "RollingBack" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command.
- value: Completed
description: The operation has completed successfully and is no longer running.
- value: Faulted
description: The operation has failed and is no longer running.
- value: Cancelled
description: The operation was cancelled by the user using CancelOperation, and is no longer running.
- value: ForceCancelled
description: The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details.
OperationStatusList:
type: array
description: A list of OperationStatus objects.
items:
$ref: '#/definitions/OperationStatus'
PartitionId:
type: string
format: uuid
description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
OperationId:
type: string
format: uuid
description: A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.
SelectedPartition:
description: This class returns information about the partition that the user-induced operation acted upon.
properties:
ServiceName:
$ref: '#/definitions/ServiceName'
description: The name of the service the partition belongs to.
PartitionId:
$ref: '#/definitions/PartitionId'
description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
OperationStatus:
description: Contains the OperationId, OperationState, and OperationType for user-induced operations.
properties:
OperationId:
$ref: '#/definitions/OperationId'
description: A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.
State:
$ref: '#/definitions/OperationState'
description: The state of the operation.
Type:
$ref: '#/definitions/OperationType'
description: The type of the operation.
ServiceName:
type: string
description: The full name of the service with 'fabric:' URI scheme.
FabricErrorCodes:
type: string
description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\""
enum:
- FABRIC_E_INVALID_PARTITION_KEY
- FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
- FABRIC_E_INVALID_ADDRESS
- FABRIC_E_APPLICATION_NOT_UPGRADING
- FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
- FABRIC_E_FABRIC_NOT_UPGRADING
- FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
- FABRIC_E_INVALID_CONFIGURATION
- FABRIC_E_INVALID_NAME_URI
- FABRIC_E_PATH_TOO_LONG
- FABRIC_E_KEY_TOO_LARGE
- FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
- FABRIC_E_INVALID_ATOMIC_GROUP
- FABRIC_E_VALUE_EMPTY
- FABRIC_E_NODE_NOT_FOUND
- FABRIC_E_APPLICATION_TYPE_NOT_FOUND
- FABRIC_E_APPLICATION_NOT_FOUND
- FABRIC_E_SERVICE_TYPE_NOT_FOUND
- FABRIC_E_SERVICE_DOES_NOT_EXIST
- FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
- FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
- FABRIC_E_PARTITION_NOT_FOUND
- FABRIC_E_REPLICA_DOES_NOT_EXIST
- FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
- FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
- FABRIC_E_DIRECTORY_NOT_FOUND
- FABRIC_E_FABRIC_VERSION_NOT_FOUND
- FABRIC_E_FILE_NOT_FOUND
- FABRIC_E_NAME_DOES_NOT_EXIST
- FABRIC_E_PROPERTY_DOES_NOT_EXIST
- FABRIC_E_ENUMERATION_COMPLETED
- FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
- FABRIC_E_KEY_NOT_FOUND
- FABRIC_E_HEALTH_ENTITY_NOT_FOUND
- FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
- FABRIC_E_APPLICATION_ALREADY_EXISTS
- FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
- FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
- FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
- FABRIC_E_SERVICE_ALREADY_EXISTS
- FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
- FABRIC_E_APPLICATION_TYPE_IN_USE
- FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
- FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
- FABRIC_E_FABRIC_VERSION_IN_USE
- FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
- FABRIC_E_NAME_ALREADY_EXISTS
- FABRIC_E_NAME_NOT_EMPTY
- FABRIC_E_PROPERTY_CHECK_FAILED
- FABRIC_E_SERVICE_METADATA_MISMATCH
- FABRIC_E_SERVICE_TYPE_MISMATCH
- FABRIC_E_HEALTH_STALE_REPORT
- FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
- FABRIC_E_NODE_HAS_NOT_STOPPED_YET
- FABRIC_E_INSTANCE_ID_MISMATCH
- FABRIC_E_VALUE_TOO_LARGE
- FABRIC_E_NO_WRITE_QUORUM
- FABRIC_E_NOT_PRIMARY
- FABRIC_E_NOT_READY
- FABRIC_E_RECONFIGURATION_PENDING
- FABRIC_E_SERVICE_OFFLINE
- E_ABORT
- FABRIC_E_COMMUNICATION_ERROR
- FABRIC_E_OPERATION_NOT_COMPLETE
- FABRIC_E_TIMEOUT
- FABRIC_E_NODE_IS_UP
- E_FAIL
- FABRIC_E_BACKUP_IS_ENABLED
- FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
- FABRIC_E_INVALID_FOR_STATELESS_SERVICES
- FABRIC_E_BACKUP_NOT_ENABLED
- FABRIC_E_BACKUP_POLICY_NOT_EXISTING
- FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
- FABRIC_E_BACKUP_IN_PROGRESS
- FABRIC_E_RESTORE_IN_PROGRESS
- FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
- FABRIC_E_INVALID_SERVICE_SCALING_POLICY
- E_INVALIDARG
- FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
- FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
- FABRIC_E_VOLUME_ALREADY_EXISTS
- FABRIC_E_VOLUME_NOT_FOUND
- SerializationError
- FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
x-ms-enum:
name: FabricErrorCodes
modelAsString: true
values:
- value: FABRIC_E_INVALID_PARTITION_KEY
- value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
- value: FABRIC_E_INVALID_ADDRESS
- value: FABRIC_E_APPLICATION_NOT_UPGRADING
- value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
- value: FABRIC_E_FABRIC_NOT_UPGRADING
- value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
- value: FABRIC_E_INVALID_CONFIGURATION
- value: FABRIC_E_INVALID_NAME_URI
- value: FABRIC_E_PATH_TOO_LONG
- value: FABRIC_E_KEY_TOO_LARGE
- value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
- value: FABRIC_E_INVALID_ATOMIC_GROUP
- value: FABRIC_E_VALUE_EMPTY
- value: FABRIC_E_NODE_NOT_FOUND
- value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
- value: FABRIC_E_APPLICATION_NOT_FOUND
- value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
- value: FABRIC_E_SERVICE_DOES_NOT_EXIST
- value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
- value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
- value: FABRIC_E_PARTITION_NOT_FOUND
- value: FABRIC_E_REPLICA_DOES_NOT_EXIST
- value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
- value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
- value: FABRIC_E_DIRECTORY_NOT_FOUND
- value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
- value: FABRIC_E_FILE_NOT_FOUND
- value: FABRIC_E_NAME_DOES_NOT_EXIST
- value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
- value: FABRIC_E_ENUMERATION_COMPLETED
- value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
- value: FABRIC_E_KEY_NOT_FOUND
- value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
- value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
- value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
- value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
- value: FABRIC_E_SERVICE_ALREADY_EXISTS
- value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_TYPE_IN_USE
- value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
- value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
- value: FABRIC_E_FABRIC_VERSION_IN_USE
- value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
- value: FABRIC_E_NAME_ALREADY_EXISTS
- value: FABRIC_E_NAME_NOT_EMPTY
- value: FABRIC_E_PROPERTY_CHECK_FAILED
- value: FABRIC_E_SERVICE_METADATA_MISMATCH
- value: FABRIC_E_SERVICE_TYPE_MISMATCH
- value: FABRIC_E_HEALTH_STALE_REPORT
- value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
- value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
- value: FABRIC_E_INSTANCE_ID_MISMATCH
- value: FABRIC_E_VALUE_TOO_LARGE
- value: FABRIC_E_NO_WRITE_QUORUM
- value: FABRIC_E_NOT_PRIMARY
- value: FABRIC_E_NOT_READY
- value: FABRIC_E_RECONFIGURATION_PENDING
- value: FABRIC_E_SERVICE_OFFLINE
- value: E_ABORT
- value: FABRIC_E_COMMUNICATION_ERROR
- value: FABRIC_E_OPERATION_NOT_COMPLETE
- value: FABRIC_E_TIMEOUT
- value: FABRIC_E_NODE_IS_UP
- value: E_FAIL
- value: FABRIC_E_BACKUP_IS_ENABLED
- value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
- value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
- value: FABRIC_E_BACKUP_NOT_ENABLED
- value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
- value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
- value: FABRIC_E_BACKUP_IN_PROGRESS
- value: FABRIC_E_RESTORE_IN_PROGRESS
- value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
- value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
- value: E_INVALIDARG
- value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
- value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
- value: FABRIC_E_VOLUME_ALREADY_EXISTS
- value: FABRIC_E_VOLUME_NOT_FOUND
- value: SerializationError
- value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
InvokeQuorumLossResult:
description: Represents information about an operation in a terminal state (Completed or Faulted).
properties:
ErrorCode:
type: integer
format: int32
description: If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
SelectedPartition:
$ref: '#/definitions/SelectedPartition'
description: This class returns information about the partition that the user-induced operation acted upon.
FabricError:
description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
properties:
Error:
$ref: '#/definitions/FabricErrorError'
description: Error object containing error code and error message.
required:
- Error
OperationType:
type: string
description: The type of the operation.
enum:
- Invalid
- PartitionDataLoss
- PartitionQuorumLoss
- PartitionRestart
- NodeTransition
x-ms-enum:
name: OperationType
modelAsString: true
values:
- value: Invalid
description: The operation state is invalid.
- value: PartitionDataLoss
description: An operation started using the StartDataLoss API.
- value: PartitionQuorumLoss
description: An operation started using the StartQuorumLoss API.
- value: PartitionRestart
description: An operation started using the StartPartitionRestart API.
- value: NodeTransition
description: An operation started using the StartNodeTransition API.
RestartPartitionResult:
description: Represents information about an operation in a terminal state (Completed or Faulted).
properties:
ErrorCode:
type: integer
format: int32
description: If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
SelectedPartition:
$ref: '#/definitions/SelectedPartition'
description: This class returns information about the partition that the user-induced operation acted upon.
NodeResult:
description: Contains information about a node that was targeted by a user-induced operation.
properties:
NodeName:
$ref: '#/definitions/NodeName'
description: The name of a Service Fabric node.
NodeInstanceId:
type: string
description: The node instance id.
NodeName:
type: string
description: The name of a Service Fabric node.
NodeTransitionResult:
description: Represents information about an operation in a terminal state (Completed or Faulted).
properties:
ErrorCode:
type: integer
format: int32
description: If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
NodeResult:
$ref: '#/definitions/NodeResult'
description: Contains information about a node that was targeted by a user-induced operation.
NodeTransitionProgress:
description: 'Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState
is Completed or Faulted.'
properties:
State:
$ref: '#/definitions/OperationState'
description: The state of the operation.
NodeTransitionResult:
$ref: '#/definitions/NodeTransitionResult'
description: Represents information about an operation in a terminal state (Completed or Faulted).
InvokeDataLossResult:
description: Represents information about an operation in a terminal state (Completed or Faulted).
properties:
ErrorCode:
type: integer
format: int32
description: If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
SelectedPartition:
$ref: '#/definitions/SelectedPartition'
description: This class returns information about the partition that the user-induced operation acted upon.
PartitionDataLossProgress:
description: Information about a partition data loss user-induced operation.
properties:
State:
$ref: '#/definitions/OperationState'
description: The state of the operation.
InvokeDataLossResult:
$ref: '#/definitions/InvokeDataLossResult'
description: Represents information about an operation in a terminal state (Completed or Faulted).
PartitionQuorumLossProgress:
description: Information about a partition quorum loss user-induced operation.
properties:
State:
$ref: '#/definitions/OperationState'
description: The state of the operation.
InvokeQuorumLossResult:
$ref: '#/definitions/InvokeQuorumLossResult'
description: Represents information about an operation in a terminal state (Completed or Faulted).
parameters:
RestartPartitionModeRequiredQueryParam:
name: RestartPartitionMode
description: Describe which partitions to restart.
in: query
x-ms-parameter-location: method
type: string
enum:
- Invalid
- AllReplicasOrInstances
- OnlyActiveSecondaries
required: true
x-ms-enum:
name: RestartPartitionMode
modelAsString: true
values:
- value: Invalid
description: Reserved. Do not pass into API.
- value: AllReplicasOrInstances
description: All replicas or instances in the partition are restarted at once.
- value: OnlyActiveSecondaries
description: Only the secondary replicas are restarted.
FaultOperationIdRequiredQueryParam:
name: OperationId
description: A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
in: query
x-ms-parameter-location: method
type: string
format: uuid
required: true
PartitionIdRequiredPathParam:
name: partitionId
in: path
x-ms-parameter-location: method
x-ms-skip-url-encoding: true
type: string
format: uuid
required: true
description: The identity of the partition.
QuorumLossDurationRequiredQueryParam:
name: QuorumLossDuration
description: The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.
in: query
x-ms-parameter-location: method
type: integer
required: true
NodeNameRequiredPathParam:
name: nodeName
in: path
x-ms-parameter-location: method
type: string
required: true
description: The name of the node.
StopDurationInSecondsRequiredQueryParam:
name: StopDurationInSeconds
in: query
x-ms-parameter-location: method
type: integer
format: int32
minimum: 0
required: true
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.
ForceRequiredQueryParam:
name: Force
description: Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation.
in: query
x-ms-parameter-location: method
type: boolean
required: true
default: false
TimeoutOptionalQueryParam:
name: timeout
in: query
x-ms-parameter-location: method
type: integer
format: int64
required: false
minimum: 1
maximum: 4294967295
default: 60
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.
DataLossModeRequiredQueryParam:
name: DataLossMode
description: This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.
in: query
x-ms-parameter-location: method
type: string
enum:
- Invalid
- PartialDataLoss
- FullDataLoss
required: true
x-ms-enum:
name: DataLossMode
modelAsString: true
values:
- value: Invalid
description: Reserved. Do not pass into API.
- value: PartialDataLoss
description: PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition.
- value: FullDataLoss
description: FullDataLoss option will drop all the replicas which means that all the data will be lost.
QuorumLossModeRequiredQueryParam:
name: QuorumLossMode
description: This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.
in: query
x-ms-parameter-location: method
type: string
enum:
- Invalid
- QuorumReplicas
- AllReplicas
required: true
x-ms-enum:
name: QuorumLossMode
modelAsString: true
values:
- value: Invalid
description: Reserved. Do not pass into API.
- value: QuorumReplicas
description: 'Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss.'
- value: AllReplicas
NodeInstanceIdRequiredQueryParam:
name: NodeInstanceId
in: query
x-ms-parameter-location: method
type: string
required: true
description: The node instance ID of the target node. This can be determined through GetNodeInfo API.
NodeTransitionTypeRequiredQueryParam:
name: NodeTransitionType
description: Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.
in: query
x-ms-parameter-location: method
type: string
enum:
- Invalid
- Start
- Stop
required: true
x-ms-enum:
name: NodeTransitionType
modelAsString: true
values:
- value: Invalid
description: Reserved. Do not pass into API.
- value: Start
description: Transition a stopped node to up.
- value: Stop
description: Transition an up node to stopped.
ApiVersion_6-0_RequiredQueryParam:
name: api-version
in: query
x-ms-parameter-location: method
type: string
enum:
- '6.0'
required: true
default: '6.0'
description: '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.'
x-ms-enum:
name: ApiVersion_6-0_RequiredQueryParam
modelAsString: true
values:
- value: '6.0'
description: The 6.0 version of the API.
StateFilterRequiredQueryParam:
name: StateFilter
description: 'Used to filter on OperationState''s for user-induced operations.
- 65535 - select All
- 1 - select Running
- 2 - select RollingBack
- 8 - select Completed
- 16 - select Faulted
- 32 - select Cancelled
- 64 - select ForceCancelled'
in: query
x-ms-parameter-location: method
type: integer
required: true
default: 65535
ServiceIdRequiredPathParam:
name: serviceId
in: path
x-ms-parameter-location: method
x-ms-skip-url-encoding: true
type: string
required: true
description: 'The identity of the service. This ID is typically the full name of the service without the ''fabric:'' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the "~" character.
For 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.'
TypeFilterRequiredQueryParam:
name: TypeFilter
description: 'Used to filter on OperationType for user-induced operations.
- 65535 - select all
- 1 - select PartitionDataLoss.
- 2 - select PartitionQuorumLoss.
- 4 - select PartitionRestart.
- 8 - select NodeTransition.'
in: query
x-ms-parameter-location: method
type: integer
required: true
default: 65535
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'