swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Partition API schemes: - https tags: - name: Partition paths: /$/GetLoadedPartitionInfoList: get: summary: Microsoft Azure Gets Ordered List Of Partitions description: Retrieves partitions which are most/least loaded according to specified metric. operationId: microsoftAzureGetloadedpartitioninfolist tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_8-0_RequiredQueryParam' - $ref: '#/parameters/MetricNameRequiredQueryParam' - $ref: '#/parameters/ServiceNameOptionalQueryParam' - $ref: '#/parameters/OrderingOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' responses: '200': description: A successful operation will return 200 status code and the requested cluster load information. schema: $ref: '#/definitions/LoadedPartitionInformationResultList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/GetPartitions: get: summary: Microsoft Azure Gets The List Of Partitions Of A Service Fabric Service description: The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition. operationId: microsoftAzureGetpartitioninfolist parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: List of partitions of a Service Fabric service. schema: $ref: '#/definitions/PagedServicePartitionInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}: get: summary: Microsoft Azure Gets The Information About A Service Fabric Partition description: Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition. operationId: microsoftAzureGetpartitioninfo parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: Information about the specified partition. schema: $ref: '#/definitions/ServicePartitionInfo' '204': description: An empty response is returned if the specified partitionId is not found in the cluster. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetServiceName: get: summary: Microsoft Azure Gets The Name Of The Service Fabric Service For A Partition description: Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster. operationId: microsoftAzureGetservicenameinfo parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: Information about the name of the service for the specified partition. schema: $ref: '#/definitions/ServiceNameInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetHealth: get: summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Partition description: Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.
Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.
If you specify a partition that does not exist in the health store, this request returns an error. operationId: microsoftAzureGetpartitionhealth parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam' - $ref: '#/parameters/ReplicasHealthStateFilerOptionalQueryParam' - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: A successful operation will return 200 status code and the health information about the specified partition. schema: $ref: '#/definitions/PartitionHealth' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' post: summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Partition, By Using The Specified Health Policy description: Gets the health information of the specified partition.
If the application health policy is specified, the health evaluation uses it to get the aggregated health state.
If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.
Use EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.
Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.
If you specify a partition that does not exist in the health store, this request returns an error. operationId: microsoftAzureGetpartitionhealthusingpolicy parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam' - $ref: '#/parameters/ReplicasHealthStateFilerOptionalQueryParam' - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam' - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: A successful operation will return 200 status code and the health information about the specified partition. schema: $ref: '#/definitions/PartitionHealth' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/ReportHealth: post: operationId: microsoftAzureReportpartitionhealth summary: Microsoft Azure Sends A Health Report On The Service Fabric Partition description: Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.
The report is sent to a Service Fabric gateway Partition, which forwards to the health store.
The report may be accepted by the gateway, but rejected by the health store after extra validation.
For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.
To see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/HealthInformationRequiredBodyParam' - $ref: '#/parameters/ImmediateOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetLoadInformation: get: summary: Microsoft Azure Gets The Load Information Of The Specified Service Fabric Partition description: Returns information about the load of a specified partition.
The response includes a list of load reports for a Service Fabric partition.
Each report includes the load metric name, value, and last reported time in UTC. operationId: microsoftAzureGetpartitionloadinformation parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Partition responses: '200': description: Information about the specified partition's last reported load metrics. schema: $ref: '#/definitions/PartitionLoadInformation' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/ResetLoad: post: operationId: microsoftAzureResetpartitionload summary: Microsoft Azure Resets The Current Load Of A Service Fabric Partition description: Resets the current load of a Service Fabric partition to the default load for the service. tags: - Partition parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/Recover: post: operationId: microsoftAzureRecoverpartition summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover A Specific Partition That Is Currently Stuck In Quorum Loss description: This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss. tags: - Partition parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/$/{serviceId}/$/GetPartitions/$/Recover: post: operationId: microsoftAzureRecoverservicepartitions summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The Specified Service That Is Currently Stuck In Quorum Loss description: Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss. tags: - Partition parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /$/RecoverSystemPartitions: post: operationId: microsoftAzureRecoversystempartitions summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The System Services That Are Currently Stuck In Quorum Loss description: Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /$/RecoverAllPartitions: post: operationId: microsoftAzureRecoverallpartitions summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover Any Services Including System Services Which Are Currently Stuck In Quorum Loss description: This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/MovePrimaryReplica: post: operationId: microsoftAzureMoveprimaryreplica summary: Microsoft Azure Moves The Primary Replica Of A Partition Of A Stateful Service description: This command moves the primary replica of a partition of a stateful service, respecting all constraints.
If NodeName parameter is specified, primary will be moved to the specified node (if constraints allow it).
If NodeName parameter is not specified, primary replica will be moved to a random node in the cluster.
If IgnoreConstraints parameter is specified and set to true, then primary will be moved regardless of the constraints. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_6-5_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/NodeNameOptionalParam' - $ref: '#/parameters/IgnoreConstraintsOptionalParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/MoveSecondaryReplica: post: operationId: microsoftAzureMovesecondaryreplica summary: Microsoft Azure Moves The Secondary Replica Of A Partition Of A Stateful Service description: This command moves the secondary replica of a partition of a stateful service, respecting all constraints.
CurrentNodeName parameter must be specified to identify the replica that is moved.
Source node name must be specified, but new node name can be omitted, and in that case replica is moved to a random node.
If IgnoreConstraints parameter is specified and set to true, then secondary will be moved regardless of the constraints. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_6-5_RequiredQueryParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/CurrentNodeNameRequiredParam' - $ref: '#/parameters/NewNodeNameOptionalParam' - $ref: '#/parameters/IgnoreConstraintsOptionalParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /$/UpdatePartitionLoad: post: operationId: microsoftAzureUpdatepartitionload summary: Microsoft Azure Update The Loads Of Provided Partitions For Specific Metrics description: Updates the load value and predicted load value for all the partitions provided for specified metrics. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_7-2_RequiredQueryParam' - $ref: '#/parameters/PartitionMetricLoadDescriptionListRequiredParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: List UpdatePartitionLoadResults. schema: $ref: '#/definitions/PagedUpdatePartitionLoadResultList' default: description: The error code response per specified partition. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveInstance: post: operationId: microsoftAzureMoveinstance summary: Microsoft Azure Moves The Instance Of A Partition Of A Stateless Service description: This command moves the instance of a partition of a stateless service, respecting all constraints.
Partition id and service name must be specified to be able to move the instance.
CurrentNodeName when specified identifies the instance that is moved. If not specified, random instance will be moved
New node name can be omitted, and in that case instance is moved to a random node.
If IgnoreConstraints parameter is specified and set to true, then instance will be moved regardless of the constraints. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_8-0_RequiredQueryParam' - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/CurrentNodeNameOptionalParam' - $ref: '#/parameters/NewNodeNameOptionalParam' - $ref: '#/parameters/IgnoreConstraintsOptionalParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveAuxiliaryReplica: post: operationId: microsoftAzureMoveauxiliaryreplica summary: Microsoft Azure Moves The Auxiliary Replica Of A Partition Of A Stateful Service description: This command moves the auxiliary replica of a partition of a stateful service, respecting all constraints.
CurrentNodeName can be omitted, and in that case a random auxiliary replica is chosen.
NewNodeName can be omitted, and in that case the auxiliary replica is moved to a random node.
If IgnoreConstraints parameter is specified and set to true, then auxiliary will be moved regardless of the constraints. tags: - Partition parameters: - $ref: '#/parameters/ApiVersion_8-1_RequiredQueryParam' - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/CurrentNodeNameOptionalParam' - $ref: '#/parameters/NewNodeNameOptionalParam' - $ref: '#/parameters/IgnoreConstraintsOptionalParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '200': description: A successful operation request will return 200 status code. 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 EntityKindHealthStateCount: description: Represents health state count for entities of the specified entity kind. properties: EntityKind: $ref: '#/definitions/EntityKind' description: The entity kind for which health states are evaluated. HealthStateCount: $ref: '#/definitions/HealthStateCount' description: The health state count for the entities of the specified kind. PartitionMetricLoadDescriptionList: type: array items: $ref: '#/definitions/PartitionMetricLoadDescription' description: List that contains load descriptions of each partition. PagedUpdatePartitionLoadResultList: description: The list of results of the call UpdatePartitionLoad. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of partition load update information. items: $ref: '#/definitions/UpdatePartitionLoadResult' HealthInformation: description: Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries. required: - SourceId - Property - HealthState properties: SourceId: type: string description: The source name that identifies the client/watchdog/system component that generated the health information. Property: type: string description: 'The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.' HealthState: $ref: '#/definitions/HealthState' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. TimeToLiveInMilliSeconds: type: string format: duration description: 'The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value.' Description: type: string description: 'The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.' SequenceNumber: type: string description: 'The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.' RemoveWhenExpired: type: boolean description: 'Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can''t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.' HealthReportId: type: string description: 'A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid' 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. HealthEvaluation: discriminator: Kind description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity. properties: Kind: $ref: '#/definitions/HealthEvaluationKind' description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values. AggregatedHealthState: $ref: '#/definitions/HealthState' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Description: type: string description: Description of the health evaluation, which represents a summary of the evaluation process. required: - Kind HealthEvaluationWrapper: description: Wrapper object for health evaluation. properties: HealthEvaluation: $ref: '#/definitions/HealthEvaluation' description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity. ServicePartitionKind: type: string description: The kind of partitioning scheme used to partition the service. enum: - Invalid - Singleton - Int64Range - Named x-ms-enum: name: ServicePartitionKind modelAsString: true values: - value: Invalid description: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Singleton description: Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1. - value: Int64Range description: Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2. - value: Named description: Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3. HealthEvent: description: Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager. allOf: - $ref: '#/definitions/HealthInformation' properties: IsExpired: type: boolean description: Returns true if the health event is expired, otherwise false. SourceUtcTimestamp: type: string format: date-time description: The date and time when the health report was sent by the source. LastModifiedUtcTimestamp: type: string format: date-time description: The date and time when the health report was last modified by the health store. LastOkTransitionAt: type: string format: date-time description: 'If the current health state is ''Ok'', this property returns the time at which the health report was first reported with ''Ok''. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first ''Ok'' health report was received. If the current health state is ''Error'' or ''Warning'', returns the date and time at which the health state was last in ''Ok'', before transitioning to a different state. If the health state was never ''Ok'', the value will be zero date-time.' LastWarningTransitionAt: type: string format: date-time description: 'If the current health state is ''Warning'', this property returns the time at which the health report was first reported with ''Warning''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Warning'' health report was received. If the current health state is ''Ok'' or ''Error'', returns the date and time at which the health state was last in ''Warning'', before transitioning to a different state. If the health state was never ''Warning'', the value will be zero date-time.' LastErrorTransitionAt: type: string format: date-time description: 'If the current health state is ''Error'', this property returns the time at which the health report was first reported with ''Error''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Error'' health report was received. If the current health state is ''Ok'' or ''Warning'', returns the date and time at which the health state was last in ''Error'', before transitioning to a different state. If the health state was never ''Error'', the value will be zero date-time.' HealthEvaluationKind: type: string description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values. enum: - Invalid - Event - Replicas - Partitions - DeployedServicePackages - DeployedApplications - Services - Nodes - Applications - SystemApplication - UpgradeDomainDeployedApplications - UpgradeDomainNodes - Replica - Partition - DeployedServicePackage - DeployedApplication - Service - Node - Application - DeltaNodesCheck - UpgradeDomainDeltaNodesCheck - ApplicationTypeApplications - NodeTypeNodes x-ms-enum: name: HealthEvaluationKind modelAsString: true values: - value: Invalid description: Indicates that the health evaluation is invalid. The value is zero. - value: Event description: Indicates that the health evaluation is for a health event. The value is 1. - value: Replicas description: Indicates that the health evaluation is for the replicas of a partition. The value is 2. - value: Partitions description: Indicates that the health evaluation is for the partitions of a service. The value is 3. - value: DeployedServicePackages description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4. - value: DeployedApplications description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5. - value: Services description: Indicates that the health evaluation is for services of an application. The value is 6. - value: Nodes description: Indicates that the health evaluation is for the cluster nodes. The value is 7. - value: Applications description: Indicates that the health evaluation is for the cluster applications. The value is 8. - value: SystemApplication description: Indicates that the health evaluation is for the system application. The value is 9. - value: UpgradeDomainDeployedApplications description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10. - value: UpgradeDomainNodes description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11. - value: Replica description: Indicates that the health evaluation is for a replica. The value is 13. - value: Partition description: Indicates that the health evaluation is for a partition. The value is 14. - value: DeployedServicePackage description: Indicates that the health evaluation is for a deployed service package. The value is 16. - value: DeployedApplication description: Indicates that the health evaluation is for a deployed application. The value is 17. - value: Service description: Indicates that the health evaluation is for a service. The value is 15. - value: Node description: Indicates that the health evaluation is for a node. The value is 12. - value: Application description: Indicates that the health evaluation is for an application. The value is 18. - value: DeltaNodesCheck description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19. - value: UpgradeDomainDeltaNodesCheck description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20. - value: ApplicationTypeApplications description: – Indicates that the health evaluation is for applications of an application type. The value is 21. - value: NodeTypeNodes description: – Indicates that the health evaluation is for nodes of a node type. The value is 22. MetricLoadDescription: description: Specifies metric load information. properties: MetricName: type: string description: The name of the reported metric. CurrentLoad: type: integer format: int64 description: The current value of the metric load. PredictedLoad: type: integer format: int64 description: The predicted value of the metric load. Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled. HealthStateCount: description: Represents information about how many health entities are in Ok, Warning and Error health state. properties: OkCount: type: integer format: int64 description: The number of health entities with aggregated health state Ok. minimum: 0 WarningCount: type: integer format: int64 description: The number of health entities with aggregated health state Warning. minimum: 0 ErrorCount: type: integer format: int64 description: The number of health entities with aggregated health state Error. minimum: 0 UnhealthyEvaluations: description: List of health evaluations that resulted in the current aggregated health state. type: array items: $ref: '#/definitions/HealthEvaluationWrapper' HealthState: type: string description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. enum: - Invalid - Ok - Warning - Error - Unknown x-ms-enum: name: HealthState modelAsString: true values: - value: Invalid description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. - value: Ok description: Indicates the health state is okay. The value is 1. - value: Warning description: Indicates the health state is at a warning level. The value is 2. - value: Error description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. - value: Unknown description: Indicates an unknown health status. The value is 65535. ServiceTypeHealthPolicyMap: type: array items: $ref: '#/definitions/ServiceTypeHealthPolicyMapItem' description: 'Defines a ServiceTypeHealthPolicy per service type name. The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service. If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.' PartitionLoadInformation: description: 'Represents load information for a partition, which contains the primary, secondary and auxiliary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport''s LastReportedUtc is set to 0.' properties: PartitionId: $ref: '#/definitions/PartitionId' description: Id of the partition. PrimaryLoadMetricReports: type: array description: Array of load reports from the primary replica for this partition. items: $ref: '#/definitions/LoadMetricReport' SecondaryLoadMetricReports: type: array description: 'Array of aggregated load reports from all secondary replicas for this partition. Array only contains the latest reported load for each metric.' items: $ref: '#/definitions/LoadMetricReport' AuxiliaryLoadMetricReports: type: array description: 'Array of aggregated load reports from all auxiliary replicas for this partition. Array only contains the latest reported load for each metric.' items: $ref: '#/definitions/LoadMetricReport' ServiceName: type: string description: The full name of the service with 'fabric:' URI scheme. ReplicaHealthState: discriminator: ServiceKind required: - ServiceKind description: Represents a base class for stateful service replica or stateless service instance health state. allOf: - $ref: '#/definitions/EntityHealthState' properties: ServiceKind: $ref: '#/definitions/ServiceKind' description: The kind of service (Stateless or Stateful). PartitionId: $ref: '#/definitions/PartitionId' description: The ID of the partition to which this replica belongs. ServiceTypeHealthPolicyMapItem: description: Defines an item in ServiceTypeHealthPolicyMap. required: - Key - Value properties: Key: type: string description: The key of the service type health policy map item. This is the name of the service type. Value: $ref: '#/definitions/ServiceTypeHealthPolicy' description: The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type. UpdatePartitionLoadResult: description: Specifies result of updating load for specified partitions. The output will be ordered based on the partition ID. properties: PartitionId: $ref: '#/definitions/PartitionId' description: Id of the partition. PartitionErrorCode: type: integer description: If OperationState is Completed - this is 0. If OperationState is Faulted - this is an error code indicating the reason. ServiceKind: type: string description: The kind of service (Stateless or Stateful). enum: - Invalid - Stateless - Stateful x-ms-enum: name: ServiceKind modelAsString: true values: - value: Invalid description: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Stateless description: Does not use Service Fabric to make its state highly available or reliable. The value is 1. - value: Stateful description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. EntityHealth: description: Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation. properties: AggregatedHealthState: $ref: '#/definitions/HealthState' description: 'The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy.' HealthEvents: type: array items: $ref: '#/definitions/HealthEvent' description: The list of health events reported on the entity. UnhealthyEvaluations: $ref: '#/definitions/UnhealthyEvaluations' description: The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager. HealthStatistics: $ref: '#/definitions/HealthStatistics' description: Shows the health statistics for all children types of the queried entity. 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 ContinuationToken: type: string description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. HealthStatistics: description: 'The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.' properties: HealthStateCountList: type: array items: $ref: '#/definitions/EntityKindHealthStateCount' description: List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state. 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 EntityHealthState: description: A base type for the health state of various entities in the cluster. It contains the aggregated health state. properties: AggregatedHealthState: $ref: '#/definitions/HealthState' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. ServiceId: type: string description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.' ServiceNameInfo: description: Information about the service name. properties: Id: $ref: '#/definitions/ServiceId' description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.' Name: $ref: '#/definitions/ServiceName' description: The full name of the service with 'fabric:' URI scheme. PartitionHealth: description: Information about the health of a Service Fabric partition. allOf: - $ref: '#/definitions/EntityHealth' properties: PartitionId: $ref: '#/definitions/PartitionId' description: ID of the partition whose health information is described by this object. ReplicaHealthStates: type: array items: $ref: '#/definitions/ReplicaHealthState' description: The list of replica health states associated with the partition. ApplicationHealthPolicy: description: Defines a health policy used to evaluate the health of an application or one of its children entities. properties: ConsiderWarningAsError: type: boolean description: Indicates whether warnings are treated with the same severity as errors. default: false MaxPercentUnhealthyDeployedApplications: type: integer description: 'The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.' default: 0 DefaultServiceTypeHealthPolicy: $ref: '#/definitions/ServiceTypeHealthPolicy' description: The health policy used by default to evaluate the health of a service type. ServiceTypeHealthPolicyMap: $ref: '#/definitions/ServiceTypeHealthPolicyMap' description: The map with service type health policy per service type name. The map is empty by default. ReplicaMetricLoadDescription: description: Specifies metric loads of a partition's specific secondary replica or instance. properties: NodeName: type: string description: Node name of a specific secondary replica or instance. ReplicaOrInstanceLoadEntries: type: array items: $ref: '#/definitions/MetricLoadDescription' description: Loads of a different metrics for a partition's secondary replica or instance. ServiceTypeHealthPolicy: description: Represents the health policy used to evaluate the health of services belonging to a service type. properties: MaxPercentUnhealthyPartitionsPerService: type: integer description: 'The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.' default: 0 MaxPercentUnhealthyReplicasPerPartition: type: integer description: 'The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.' default: 0 MaxPercentUnhealthyServices: type: integer description: 'The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.' default: 0 LoadedPartitionInformationResult: description: Represents partition information. properties: ServiceName: type: string description: Name of the service this partition belongs to. PartitionId: $ref: '#/definitions/PartitionId' description: Id of the partition. MetricName: type: string description: Name of the metric for which this information is provided. Load: type: integer format: int64 description: Load for metric. required: - ServiceName - PartitionId - MetricName - Load LoadedPartitionInformationResultList: description: Represents data structure that contains top/least loaded partitions for a certain metric. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of application information. items: $ref: '#/definitions/LoadedPartitionInformationResult' ServicePartitionInfo: discriminator: ServiceKind description: Information about a partition of a Service Fabric service. required: - ServiceKind properties: ServiceKind: $ref: '#/definitions/ServiceKind' description: The kind of service (Stateless or Stateful). HealthState: $ref: '#/definitions/HealthState' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. PartitionStatus: $ref: '#/definitions/ServicePartitionStatus' description: The status of the service fabric service partition. PartitionInformation: $ref: '#/definitions/PartitionInformation' description: Information about the partition identity, partitioning scheme and keys supported by it. PartitionMetricLoadDescription: description: Represents load information for a partition, which contains the metrics load information about primary, all secondary replicas/instances or a specific secondary replica/instance on a specific node , all auxiliary replicas or a specific auxiliary replica on a specific node. properties: PartitionId: $ref: '#/definitions/PartitionId' description: Id of the partition. PrimaryReplicaLoadEntries: type: array description: Partition's load information for primary replica, in case partition is from a stateful service. items: $ref: '#/definitions/MetricLoadDescription' SecondaryReplicasOrInstancesLoadEntries: type: array description: Partition's load information for all secondary replicas or instances. items: $ref: '#/definitions/MetricLoadDescription' SecondaryReplicaOrInstanceLoadEntriesPerNode: type: array description: Partition's load information for a specific secondary replica or instance located on a specific node. items: $ref: '#/definitions/ReplicaMetricLoadDescription' AuxiliaryReplicasLoadEntries: type: array description: Partition's load information for all auxiliary replicas. items: $ref: '#/definitions/MetricLoadDescription' AuxiliaryReplicaLoadEntriesPerNode: type: array description: Partition's load information for a specific auxiliary replica located on a specific node. items: $ref: '#/definitions/ReplicaMetricLoadDescription' LoadMetricReport: description: Represents the load metric report which contains the time metric was reported, its name and value. properties: LastReportedUtc: type: string format: date-time description: Gets the UTC time when the load was reported. Name: type: string description: The name of the load metric. Value: type: string format: int32 description: The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue. CurrentValue: type: string format: double description: The value of the load metric. EntityKind: type: string description: The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. enum: - Invalid - Node - Partition - Service - Application - Replica - DeployedApplication - DeployedServicePackage - Cluster x-ms-enum: name: EntityKind modelAsString: true values: - value: Invalid description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero. - value: Node description: Indicates the entity is a Service Fabric node. The value is 1. - value: Partition description: Indicates the entity is a Service Fabric partition. The value is 2. - value: Service description: Indicates the entity is a Service Fabric service. The value is 3. - value: Application description: Indicates the entity is a Service Fabric application. The value is 4. - value: Replica description: Indicates the entity is a Service Fabric replica. The value is 5. - value: DeployedApplication description: Indicates the entity is a Service Fabric deployed application. The value is 6. - value: DeployedServicePackage description: Indicates the entity is a Service Fabric deployed service package. The value is 7. - value: Cluster description: Indicates the entity is a Service Fabric cluster. The value is 8. ServicePartitionStatus: type: string description: The status of the service fabric service partition. enum: - Invalid - Ready - NotReady - InQuorumLoss - Reconfiguring - Deleting x-ms-enum: name: ServicePartitionStatus modelAsString: true values: - value: Invalid description: Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Ready description: Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1. - value: NotReady description: Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2. - value: InQuorumLoss description: Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3. - value: Reconfiguring description: Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4. - value: Deleting description: Indicates that the partition is being deleted. The value is 5. PartitionInformation: discriminator: ServicePartitionKind description: Information about the partition identity, partitioning scheme and keys supported by it. required: - ServicePartitionKind properties: ServicePartitionKind: $ref: '#/definitions/ServicePartitionKind' description: The kind of partitioning scheme used to partition the service. Id: $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. PagedServicePartitionInfoList: description: The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of service partition information. items: $ref: '#/definitions/ServicePartitionInfo' parameters: PartitionMetricLoadDescriptionListRequiredParam: name: PartitionMetricLoadDescriptionList in: body description: Description of updating load for list of partitions. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/PartitionMetricLoadDescriptionList' IgnoreConstraintsOptionalParam: name: IgnoreConstraints in: query x-ms-parameter-location: method type: boolean required: false default: false description: Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored. ImmediateOptionalQueryParam: name: Immediate in: query x-ms-parameter-location: method type: boolean required: false default: false description: 'A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn''t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.' HealthInformationRequiredBodyParam: name: HealthInformation in: body description: Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/HealthInformation' 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. ApiVersion_6-5_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.5' required: true default: '6.5' description: 'The version of the API. This parameter is required and its value must be ''6.5''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_6-5_RequiredQueryParam modelAsString: true values: - value: '6.5' description: The 6.5 version of the API. ApiVersion_6-4_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.4' required: true default: '6.4' description: 'The version of the API. This parameter is required and its value must be ''6.4''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_6-4_RequiredQueryParam modelAsString: true values: - value: '6.4' description: The 6.4 version of the API. ApplicationHealthPolicyOptionalBodyParam: name: ApplicationHealthPolicy in: body description: 'Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.' required: false x-ms-parameter-location: method schema: $ref: '#/definitions/ApplicationHealthPolicy' CurrentNodeNameOptionalParam: name: CurrentNodeName in: query x-ms-parameter-location: method type: string required: false description: The name of the source node for instance move. If not specified, instance is moved from a random node. ApiVersion_8-0_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '8.0' required: true default: '8.0' description: 'The version of the API. This parameter is required and its value must be ''8.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 version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_8-0_RequiredQueryParam modelAsString: true values: - value: '8.0' description: The 8.0 version of the API. ApiVersion_7-2_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '7.2' required: true default: '7.2' description: 'The version of the API. This parameter is required and its value must be ''7.2''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_7-2_RequiredQueryParam modelAsString: true values: - value: '7.2' description: The 7.2 version of the API. OrderingOptionalQueryParam: name: Ordering description: Ordering of partitions' load. in: query x-ms-parameter-location: method type: string required: false default: Desc enum: - Desc - Asc x-ms-enum: name: Ordering modelAsString: true values: - value: Desc description: Sort load descending. - value: Asc description: Sort load ascending. MetricNameRequiredQueryParam: name: MetricName in: query x-ms-parameter-location: method type: string required: true description: Name of the metric based on which to get ordered list of partitions. NodeNameOptionalParam: name: NodeName in: query x-ms-parameter-location: method type: string required: false description: The name of the node. EventsHealthStateFilterOptionalQueryParam: name: EventsHealthStateFilter description: 'Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ''OR'' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.' in: query x-ms-parameter-location: method type: integer required: false default: 0 ServiceNameOptionalQueryParam: name: ServiceName in: query x-ms-parameter-location: method type: string required: false description: The name of a service. 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. NewNodeNameOptionalParam: name: NewNodeName in: query x-ms-parameter-location: method type: string required: false description: The name of the target node for secondary replica or instance move. If not specified, replica or instance is moved to a random node. ExcludeHealthStatisticsOptionalQueryParam: name: ExcludeHealthStatistics description: 'Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.' in: query x-ms-parameter-location: method type: boolean required: false default: false ApiVersion_8-1_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '8.1' required: true default: '8.1' description: 'The version of the API. This parameter is required and its value must be ''8.1''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_8-1_RequiredQueryParam modelAsString: true values: - value: '8.1' description: The 8.1 version of the API. 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. CurrentNodeNameRequiredParam: name: CurrentNodeName in: query x-ms-parameter-location: method type: string required: true description: The name of the source node for secondary replica move. 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.' MaxResultsOptionalQueryParam: name: MaxResults in: query x-ms-parameter-location: method type: integer format: int64 minimum: 0 default: 0 required: false description: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. ContinuationTokenOptionalQueryParam: name: ContinuationToken in: query x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: false description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded. ReplicasHealthStateFilerOptionalQueryParam: name: ReplicasHealthStateFilter description: 'Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.' in: query x-ms-parameter-location: method type: integer required: false default: 0 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'