swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector RepairManagement API
schemes:
- https
tags:
- name: RepairManagement
paths:
/$/CreateRepairTask:
post:
operationId: microsoftAzureCreaterepairtask
summary: Microsoft Azure Creates A New Repair Task
description: For clusters that have the Repair Manager Service configured,
this API provides a way to create repair tasks that run automatically or manually.
For repair tasks that run automatically, an appropriate repair executor
must be running for each repair action to run automatically.
These are currently only available in specially-configured Azure Cloud Services.
To create a manual repair task, provide the set of impacted node names and the
expected impact. When the state of the created repair task changes to approved,
you can safely perform repair actions on those nodes.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides information about the created repair task.'
schema:
$ref: '#/definitions/RepairTaskUpdateInfo'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/CancelRepairTask:
post:
operationId: microsoftAzureCancelrepairtask
summary: Microsoft Azure Requests The Cancellation Of The Given Repair Task
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskCancelDescriptionRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides information about the updated repair task.
Success indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.
Clients may use the State property of the repair task to determine the current state of the repair task.'
schema:
$ref: '#/definitions/RepairTaskUpdateInfo'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/DeleteRepairTask:
post:
operationId: microsoftAzureDeleterepairtask
summary: Microsoft Azure Deletes A Completed Repair Task
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: A successful operation will return 200 status code.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/GetRepairTaskList:
get:
operationId: microsoftAzureGetrepairtasklist
summary: Microsoft Azure Gets A List Of Repair Tasks Matching The Given Filters
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskIdFilterOptionalQueryParam'
- $ref: '#/parameters/RepairTaskStateFilterOptionalQueryParam'
- $ref: '#/parameters/RepairTaskExecutorFilterOptionalQueryParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides a list of repair tasks matching all of the given filters.'
schema:
$ref: '#/definitions/RepairTaskList'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/ForceApproveRepairTask:
post:
operationId: microsoftAzureForceapproverepairtask
summary: Microsoft Azure Forces The Approval Of The Given Repair Task
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskApproveDescriptionRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides information about the updated repair task.'
schema:
$ref: '#/definitions/RepairTaskUpdateInfo'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/UpdateRepairTaskHealthPolicy:
post:
operationId: microsoftAzureUpdaterepairtaskhealthpolicy
summary: Microsoft Azure Updates The Health Policy Of The Given Repair Task
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides information about the updated repair task.'
schema:
$ref: '#/definitions/RepairTaskUpdateInfo'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/UpdateRepairExecutionState:
post:
operationId: microsoftAzureUpdaterepairexecutionstate
summary: Microsoft Azure Updates The Execution State Of A Repair Task
description: This API supports the Service Fabric platform; it is not meant to be used directly from your code.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/RepairTaskRequiredBodyParam'
tags:
- RepairManagement
responses:
'200':
description: 'A successful operation will return 200 status code.
The response body provides information about the updated repair task.'
schema:
$ref: '#/definitions/RepairTaskUpdateInfo'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
definitions:
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
RepairTaskUpdateHealthPolicyDescription:
description: 'Describes a request to update the health policy of a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
TaskId:
type: string
description: The ID of the repair task to be updated.
Version:
type: string
description: The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed.
PerformPreparingHealthCheck:
type: boolean
description: A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
PerformRestoringHealthCheck:
type: boolean
description: A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
required:
- TaskId
RepairTargetKind:
description: Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
type: string
enum:
- Invalid
- Node
x-ms-enum:
name: RepairTargetKind
modelAsString: true
values:
- value: Invalid
description: The repair target is not valid or is of an unknown type.
- value: Node
description: The repair target is a set of Service Fabric nodes.
RepairTask:
description: 'Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
TaskId:
type: string
description: The ID of the repair task.
Version:
type: string
description: 'The version of the repair task.
When creating a new repair task, the version must be set to zero. When updating a repair task,
the version is used for optimistic concurrency checks. If the version is
set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the
update will only succeed if the actual current version of the repair task matches this value.'
Description:
type: string
description: 'A description of the purpose of the repair task, or other informational details.
May be set when the repair task is created, and is immutable once set.'
State:
type: string
enum:
- Invalid
- Created
- Claimed
- Preparing
- Approved
- Executing
- Restoring
- Completed
description: The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.
x-ms-enum:
name: State
modelAsString: true
values:
- value: Invalid
description: Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value.
- value: Created
description: Indicates that the repair task has been created.
- value: Claimed
description: Indicates that the repair task has been claimed by a repair executor.
- value: Preparing
description: Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully.
- value: Approved
description: Indicates that the repair task has been approved by the Repair Manager and is safe to execute.
- value: Executing
description: Indicates that execution of the repair task is in progress.
- value: Restoring
description: Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online.
- value: Completed
description: Indicates that the repair task has completed, and no further state changes will occur.
Flags:
type: integer
description: 'A bitwise-OR of the following values, which gives additional details about the status of the repair task.
- 1 - Cancellation of the repair has been requested
- 2 - Abort of the repair has been requested
- 4 - Approval of the repair was forced via client request'
Action:
type: string
description: The requested repair action. Must be specified when the repair task is created, and is immutable once set.
Target:
$ref: '#/definitions/RepairTargetDescriptionBase'
description: 'The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.
May be set when the repair task is created, and is immutable once set.'
Executor:
type: string
description: The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.
ExecutorData:
type: string
description: A data string that the repair executor can use to store its internal state.
Impact:
$ref: '#/definitions/RepairImpactDescriptionBase'
description: 'The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.
Impact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set.'
ResultStatus:
type: string
enum:
- Invalid
- Succeeded
- Cancelled
- Interrupted
- Failed
- Pending
description: A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.
x-ms-enum:
name: ResultStatus
modelAsString: true
values:
- value: Invalid
description: Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value.
- value: Succeeded
description: Indicates that the repair task completed execution successfully.
- value: Cancelled
description: Indicates that the repair task was cancelled prior to execution.
- value: Interrupted
description: Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed.
- value: Failed
description: Indicates that there was a failure during execution of the repair task. Some work may have been performed.
- value: Pending
description: Indicates that the repair task result is not yet available, because the repair task has not finished executing.
ResultCode:
type: integer
description: 'A numeric value providing additional details about the result of the repair task execution.
May be specified in the Restoring and later states, and is immutable once set.'
ResultDetails:
type: string
description: 'A string providing additional details about the result of the repair task execution.
May be specified in the Restoring and later states, and is immutable once set.'
History:
$ref: '#/definitions/RepairTaskHistory'
description: 'An object that contains timestamps of the repair task''s state transitions.
These timestamps are updated by the system, and cannot be directly modified.'
PreparingHealthCheckState:
$ref: '#/definitions/RepairTaskHealthCheckState'
description: The workflow state of the health check when the repair task is in the Preparing state.
RestoringHealthCheckState:
$ref: '#/definitions/RepairTaskHealthCheckState'
description: The workflow state of the health check when the repair task is in the Restoring state.
PerformPreparingHealthCheck:
type: boolean
description: A value to determine if health checks will be performed when the repair task enters the Preparing state.
PerformRestoringHealthCheck:
type: boolean
description: A value to determine if health checks will be performed when the repair task enters the Restoring state.
required:
- TaskId
- Action
- State
RepairTaskUpdateInfo:
description: 'Describes the result of an operation that created or updated a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
Version:
type: string
description: The new version of the repair task.
required:
- Version
RepairTargetDescriptionBase:
discriminator: Kind
description: 'Describes the entities targeted by a repair action.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
Kind:
$ref: '#/definitions/RepairTargetKind'
description: The kind of repair target described by the current object.
required:
- Kind
RepairTaskHistory:
description: 'A record of the times when the repair task entered each state.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
CreatedUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Created state.
ClaimedUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Claimed state.
PreparingUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Preparing state.
ApprovedUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Approved state
ExecutingUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Executing state
RestoringUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Restoring state
CompletedUtcTimestamp:
type: string
format: date-time
description: The time when the repair task entered the Completed state
PreparingHealthCheckStartUtcTimestamp:
type: string
format: date-time
description: The time when the repair task started the health check in the Preparing state.
PreparingHealthCheckEndUtcTimestamp:
type: string
format: date-time
description: The time when the repair task completed the health check in the Preparing state.
RestoringHealthCheckStartUtcTimestamp:
type: string
format: date-time
description: The time when the repair task started the health check in the Restoring state.
RestoringHealthCheckEndUtcTimestamp:
type: string
format: date-time
description: The time when the repair task completed the health check in the Restoring state.
RepairImpactKind:
description: Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
type: string
enum:
- Invalid
- Node
x-ms-enum:
name: RepairImpactKind
modelAsString: true
values:
- value: Invalid
description: The repair impact is not valid or is of an unknown type.
- value: Node
description: The repair impact affects a set of Service Fabric nodes.
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
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
RepairTaskDeleteDescription:
description: 'Describes a request to delete a completed repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
TaskId:
type: string
description: The ID of the completed repair task to be deleted.
Version:
type: string
description: The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
required:
- TaskId
RepairImpactDescriptionBase:
discriminator: Kind
description: 'Describes the expected impact of executing a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
Kind:
$ref: '#/definitions/RepairImpactKind'
description: The kind of repair impact represented by the current object.
required:
- Kind
RepairTaskCancelDescription:
description: 'Describes a request to cancel a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
TaskId:
type: string
description: The ID of the repair task.
Version:
type: string
description: The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
RequestAbort:
type: boolean
description: _True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started.
required:
- TaskId
RepairTaskList:
type: array
description: A list of repair tasks.
items:
$ref: '#/definitions/RepairTask'
RepairTaskHealthCheckState:
description: Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
type: string
enum:
- NotStarted
- InProgress
- Succeeded
- Skipped
- TimedOut
x-ms-enum:
name: RepairTaskHealthCheckState
modelAsString: true
values:
- value: NotStarted
description: Indicates that the health check has not started.
- value: InProgress
description: Indicates that the health check is in progress.
- value: Succeeded
description: Indicates that the health check succeeded.
- value: Skipped
description: Indicates that the health check was skipped.
- value: TimedOut
description: Indicates that the health check timed out.
RepairTaskApproveDescription:
description: 'Describes a request for forced approval of a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.'
properties:
TaskId:
type: string
description: The ID of the repair task.
Version:
type: string
description: The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
required:
- TaskId
parameters:
RepairTaskIdFilterOptionalQueryParam:
name: TaskIdFilter
description: The repair task ID prefix to be matched.
in: query
x-ms-parameter-location: method
type: string
required: false
RepairTaskRequiredBodyParam:
name: RepairTask
in: body
description: Describes the repair task to be created or updated.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/RepairTask'
RepairTaskDeleteDescriptionRequiredBodyParam:
name: RepairTaskDeleteDescription
in: body
description: Describes the repair task to be deleted.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/RepairTaskDeleteDescription'
RepairTaskExecutorFilterOptionalQueryParam:
name: ExecutorFilter
description: The name of the repair executor whose claimed tasks should be included in the list.
in: query
x-ms-parameter-location: method
type: string
required: false
RepairTaskCancelDescriptionRequiredBodyParam:
name: RepairTaskCancelDescription
in: body
description: Describes the repair task to be cancelled.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/RepairTaskCancelDescription'
RepairTaskStateFilterOptionalQueryParam:
name: StateFilter
description: 'A bitwise-OR of the following values, specifying which task states should be included in the result list.
- 1 - Created
- 2 - Claimed
- 4 - Preparing
- 8 - Approved
- 16 - Executing
- 32 - Restoring
- 64 - Completed'
in: query
x-ms-parameter-location: method
type: integer
required: false
RepairTaskApproveDescriptionRequiredBodyParam:
name: RepairTaskApproveDescription
in: body
description: Describes the repair task to be approved.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/RepairTaskApproveDescription'
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.
RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam:
name: RepairTaskUpdateHealthPolicyDescription
in: body
description: Describes the repair task healthy policy to be updated.
x-ms-parameter-location: method
required: true
schema:
$ref: '#/definitions/RepairTaskUpdateHealthPolicyDescription'
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'