swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector Infrastructure API
schemes:
- https
tags:
- name: Infrastructure
paths:
/$/InvokeInfrastructureCommand:
post:
operationId: microsoftAzureInvokeinfrastructurecommand
summary: Microsoft Azure Invokes An Administrative Command On The Given Infrastructure Service Instance
description: For clusters that have one or more instances of the Infrastructure Service configured,
this API provides a way to send infrastructure-specific commands to a particular
instance of the Infrastructure Service.
Available commands and their corresponding response formats vary depending upon
the infrastructure on which the cluster is running.
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/InfrastructureCommandRequiredQueryParam'
- $ref: '#/parameters/InfrastructureServiceIdOptionalQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Infrastructure
responses:
'200':
description: 'The response from the infrastructure service. The response format is a JSON stream.
The contents of the response depend on which command was issued.'
schema:
$ref: '#/definitions/InfrastructureServiceResponse'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/$/InvokeInfrastructureQuery:
get:
operationId: microsoftAzureInvokeinfrastructurequery
summary: Microsoft Azure Invokes A Read Only Query On The Given Infrastructure Service Instance
description: For clusters that have one or more instances of the Infrastructure Service configured,
this API provides a way to send infrastructure-specific queries to a particular
instance of the Infrastructure Service.
Available commands and their corresponding response formats vary depending upon
the infrastructure on which the cluster is running.
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/InfrastructureCommandRequiredQueryParam'
- $ref: '#/parameters/InfrastructureServiceIdOptionalQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Infrastructure
responses:
'200':
description: 'The response from the infrastructure service. The response format is a JSON stream.
The contents of the response depend on which command was issued.'
schema:
$ref: '#/definitions/InfrastructureServiceResponse'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
definitions:
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
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
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
InfrastructureServiceResponse:
type: string
description: 'This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.
The content of the response depends on which command was issued to the infrastructure service.'
parameters:
InfrastructureServiceIdOptionalQueryParam:
name: ServiceId
in: query
x-ms-parameter-location: method
type: string
description: The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.
required: false
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.
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.
InfrastructureCommandRequiredQueryParam:
name: Command
description: The text of the command to be invoked. The content of the command is infrastructure-specific.
in: query
x-ms-parameter-location: method
type: string
required: true
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'