Reference for StartAttachabilityCheck
Url: sqlserver/startAttachabilityCheck/
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | XML | Example,Schema |
| Response | XML | Example,Schema |
The following is an example request XML body:
<?xml version="1.0" encoding="utf-16"?>
<startAttachabilityCheckRequest xmlns="http://apprecovery.com/management/api/2010/05">
<CallbackInfo>
<automaticallyDetermineReplayEngineAddress>true</automaticallyDetermineReplayEngineAddress>
<domain>String content</domain>
<password>String content</password>
<replayEngineIpv4Address>4294967295</replayEngineIpv4Address>
<replayEnginePort>4294967295</replayEnginePort>
<securityProvider>String content</securityProvider>
<userName>String content</userName>
</CallbackInfo>
<connectionTimeout>P428DT10H30M12.3S</connectionTimeout>
<executionTimeout>P428DT10H30M12.3S</executionTimeout>
<fileLocations>
<databaseFileLocationInfo>
<databaseFilePathOnVolumeImage>String content</databaseFilePathOnVolumeImage>
<databaseName>String content</databaseName>
<epoch>4294967295</epoch>
<instanceName>String content</instanceName>
<mountInfo>
<mountPoint>String content</mountPoint>
<volumeName>
<guidName>String content</guidName>
<displayName>String content</displayName>
</volumeName>
</mountInfo>
<volumeImageId>String content</volumeImageId>
</databaseFileLocationInfo>
<databaseFileLocationInfo>
<databaseFilePathOnVolumeImage>String content</databaseFilePathOnVolumeImage>
<databaseName>String content</databaseName>
<epoch>4294967295</epoch>
<instanceName>String content</instanceName>
<mountInfo>
<mountPoint>String content</mountPoint>
<volumeName>
<guidName>String content</guidName>
<displayName>String content</displayName>
</volumeName>
</mountInfo>
<volumeImageId>String content</volumeImageId>
</databaseFileLocationInfo>
</fileLocations>
<instances>
<instanceInfo>
<name>String content</name>
<version>Unknown</version>
<versionNumber>String content</versionNumber>
<databases>
<database>
<name>String content</name>
<id>2147483647</id>
<isOnline>true</isOnline>
<isDeleted>true</isDeleted>
<fileGroups>
<fileGroup>
<id>2147483647</id>
<name>String content</name>
<isDefault>true</isDefault>
<isFileStream>true</isFileStream>
<dataFiles>
<dataFile>
<path>String content</path>
<isPrimary>true</isPrimary>
<size>18446744073709551615</size>
<pathVolume>
<guidName />
</pathVolume>
<displayPath>String content</displayPath>
</dataFile>
<dataFile>
<path>String content</path>
<isPrimary>true</isPrimary>
<size>18446744073709551615</size>
<pathVolume />
<displayPath />
</dataFile>
</dataFiles>
</fileGroup>
<fileGroup>
<id>2147483647</id>
<name>String content</name>
<isDefault>true</isDefault>
<isFileStream>true</isFileStream>
<dataFiles>
<dataFile />
</dataFiles>
</fileGroup>
</fileGroups>
<logFiles>
<logFile />
</logFiles>
<lastAttachabilityCheckTimeStamp />
</database>
</databases>
</instanceInfo>
</instances>
<maxDetachRetries>4294967295</maxDetachRetries>
<maxRetries>4294967295</maxRetries>
<nonPooledConnection>true</nonPooledConnection>
<skipCheckWhenFileStreamPathTooLong>true</skipCheckWhenFileStreamPathTooLong>
<sqlDatabaseLockTimeout>P428DT10H30M12.3S</sqlDatabaseLockTimeout>
</startAttachabilityCheckRequest>
The following is an example response XML body:
No Xml response output for this method.
The following is the request XML Schema:
<?xml version="1.0" encoding="utf-16"?>
<Schemas>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql.Base" />
<xs:complexType name="startAttachabilityCheckRequest">
<xs:sequence>
<xs:element minOccurs="0" name="CallbackInfo" nillable="true" type="tns:replayEngineCallbackInfo" />
<xs:element minOccurs="0" name="connectionTimeout" type="ser:duration" />
<xs:element minOccurs="0" name="executionTimeout" type="ser:duration" />
<xs:element minOccurs="0" name="fileLocations" nillable="true" type="tns:databaseFileLocationCollection" />
<xs:element minOccurs="0" name="instances" nillable="true" type="tns:instanceInfoCollection" />
<xs:element minOccurs="0" name="maxDetachRetries" type="xs:unsignedInt" />
<xs:element minOccurs="0" name="maxRetries" type="xs:unsignedInt" />
<xs:element minOccurs="0" name="nonPooledConnection" type="xs:boolean" />
<xs:element minOccurs="0" name="skipCheckWhenFileStreamPathTooLong" type="xs:boolean" />
<xs:element minOccurs="0" name="sqlDatabaseLockTimeout" type="ser:duration" />
</xs:sequence>
</xs:complexType>
<xs:element name="startAttachabilityCheckRequest" nillable="true" type="tns:startAttachabilityCheckRequest" />
<xs:complexType name="replayEngineCallbackInfo">
<xs:sequence>
<xs:element minOccurs="0" name="automaticallyDetermineReplayEngineAddress" type="xs:boolean" />
<xs:element minOccurs="0" name="domain" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="password" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="replayEngineIpv4Address" type="xs:unsignedInt" />
<xs:element minOccurs="0" name="replayEnginePort" type="xs:unsignedInt" />
<xs:element minOccurs="0" name="securityProvider" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="userName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="replayEngineCallbackInfo" nillable="true" type="tns:replayEngineCallbackInfo" />
<xs:complexType name="databaseFileLocationCollection">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="databaseFileLocationInfo" nillable="true" type="tns:databaseFileLocationInfo" />
</xs:sequence>
</xs:complexType>
<xs:element name="databaseFileLocationCollection" nillable="true" type="tns:databaseFileLocationCollection" />
<xs:complexType name="databaseFileLocationInfo">
<xs:sequence>
<xs:element minOccurs="0" name="databaseFilePathOnVolumeImage" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="databaseName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="epoch" type="xs:unsignedInt" />
<xs:element minOccurs="0" name="instanceName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="mountInfo" nillable="true" type="tns:localMountInfo" />
<xs:element minOccurs="0" name="volumeImageId" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="databaseFileLocationInfo" nillable="true" type="tns:databaseFileLocationInfo" />
<xs:complexType name="localMountInfo">
<xs:sequence>
<xs:element minOccurs="0" name="mountPoint" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="volumeName" nillable="true" type="tns:volumeName" />
</xs:sequence>
</xs:complexType>
<xs:element name="localMountInfo" nillable="true" type="tns:localMountInfo" />
<xs:complexType name="volumeName">
<xs:sequence>
<xs:element minOccurs="0" name="guidName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="displayName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="volumeName" nillable="true" type="tns:volumeName" />
<xs:complexType name="instanceInfoCollection">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="instanceInfo" nillable="true" type="tns:instanceInfo" />
</xs:sequence>
</xs:complexType>
<xs:element name="instanceInfoCollection" nillable="true" type="tns:instanceInfoCollection" />
<xs:complexType name="instanceInfo">
<xs:complexContent mixed="false">
<xs:extension base="tns:instanceBase">
<xs:sequence>
<xs:element minOccurs="0" name="databases" nillable="true" type="tns:databases" />
<xs:element minOccurs="0" name="instanceCredentials" nillable="true" type="tns:instanceCredentials" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="instanceInfo" nillable="true" type="tns:instanceInfo" />
<xs:complexType name="instanceBase">
<xs:sequence>
<xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="version" xmlns:q1="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql" type="q1:SqlServerVersion" />
<xs:element minOccurs="0" name="versionNumber" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="instanceBase" nillable="true" type="tns:instanceBase" />
<xs:complexType name="databases">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="database" nillable="true" type="tns:database" />
</xs:sequence>
</xs:complexType>
<xs:element name="databases" nillable="true" type="tns:databases" />
<xs:complexType name="database">
<xs:complexContent mixed="false">
<xs:extension base="tns:databaseBase">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="database" nillable="true" type="tns:database" />
<xs:complexType name="databaseBase">
<xs:sequence>
<xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="id" type="xs:int" />
<xs:element minOccurs="0" name="isOnline" type="xs:boolean" />
<xs:element minOccurs="0" name="isDeleted" type="xs:boolean" />
<xs:element minOccurs="0" name="fileGroups" nillable="true" type="tns:fileGroups" />
<xs:element minOccurs="0" name="logFiles" nillable="true" type="tns:logFiles" />
<xs:element minOccurs="0" name="lastAttachabilityCheckTimeStamp" type="xs:dateTime">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="isAccessible" type="xs:boolean" />
<xs:element minOccurs="0" name="fullTextCatalogs" nillable="true" type="tns:fullTextCatalogs" />
<xs:element minOccurs="0" name="isSystemDatabase" type="xs:boolean" />
<xs:element minOccurs="0" name="availabilityGroupName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="availabilityReplicaRole" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql.Base" type="q2:AvailabilityReplicaRole" />
<xs:element minOccurs="0" name="isReportServicesDatabase" nillable="true" type="tns:roles" />
<xs:element minOccurs="0" name="isAvailabilitySynchronizationError" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="databaseBase" nillable="true" type="tns:databaseBase" />
<xs:complexType name="fileGroups">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="fileGroup" nillable="true" type="tns:fileGroup" />
</xs:sequence>
</xs:complexType>
<xs:element name="fileGroups" nillable="true" type="tns:fileGroups" />
<xs:complexType name="fileGroup">
<xs:sequence>
<xs:element minOccurs="0" name="id" type="xs:int" />
<xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="isDefault" type="xs:boolean" />
<xs:element minOccurs="0" name="isFileStream" type="xs:boolean" />
<xs:element minOccurs="0" name="dataFiles" nillable="true" type="tns:dataFiles" />
</xs:sequence>
</xs:complexType>
<xs:element name="fileGroup" nillable="true" type="tns:fileGroup" />
<xs:complexType name="dataFiles">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="dataFile" nillable="true" type="tns:dataFile" />
</xs:sequence>
</xs:complexType>
<xs:element name="dataFiles" nillable="true" type="tns:dataFiles" />
<xs:complexType name="dataFile">
<xs:sequence>
<xs:element minOccurs="0" name="path" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="isPrimary" type="xs:boolean" />
<xs:element minOccurs="0" name="size" type="xs:unsignedLong" />
<xs:element minOccurs="0" name="pathVolume" nillable="true" type="tns:volumeName" />
<xs:element minOccurs="0" name="displayPath" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="dataFile" nillable="true" type="tns:dataFile" />
<xs:complexType name="logFiles">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="logFile" nillable="true" type="tns:logFile" />
</xs:sequence>
</xs:complexType>
<xs:element name="logFiles" nillable="true" type="tns:logFiles" />
<xs:complexType name="logFile">
<xs:sequence>
<xs:element minOccurs="0" name="path" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="size" type="xs:unsignedLong" />
<xs:element minOccurs="0" name="pathVolume" nillable="true" type="tns:volumeName" />
<xs:element minOccurs="0" name="displayPath" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="logFile" nillable="true" type="tns:logFile" />
<xs:complexType name="fullTextCatalogs">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="fullTextCatalog" nillable="true" type="tns:fullTextCatalog" />
</xs:sequence>
</xs:complexType>
<xs:element name="fullTextCatalogs" nillable="true" type="tns:fullTextCatalogs" />
<xs:complexType name="fullTextCatalog">
<xs:sequence>
<xs:element minOccurs="0" name="location" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="locationVolume" nillable="true" type="tns:volumeName" />
<xs:element minOccurs="0" name="displayLocation" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="fullTextCatalog" nillable="true" type="tns:fullTextCatalog" />
<xs:complexType name="roles">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="role" nillable="true" type="tns:role" />
</xs:sequence>
</xs:complexType>
<xs:element name="roles" nillable="true" type="tns:roles" />
<xs:complexType name="role">
<xs:sequence>
<xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="role" nillable="true" type="tns:role" />
<xs:complexType name="instanceCredentials">
<xs:complexContent mixed="false">
<xs:extension base="tns:baseCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="instanceName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="useDefaultCredentials" type="xs:boolean" />
<xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="instanceCredentials" nillable="true" type="tns:instanceCredentials" />
<xs:complexType name="baseCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="credentialsAccountId" type="ser:guid" />
<xs:element minOccurs="0" name="encryptPassword" type="xs:boolean" />
<xs:element minOccurs="0" name="password" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="passwordEncrypted" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="userName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="baseCredentials" nillable="true" type="tns:baseCredentials" />
<xs:complexType name="oracleInstanceCredentials">
<xs:complexContent mixed="false">
<xs:extension base="tns:baseCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="instanceServiceName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="instanceSid" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="port" type="xs:int" />
<xs:element minOccurs="0" name="tnsNetworkAlias" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="useWindowsAuthentication" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="oracleInstanceCredentials" nillable="true" type="tns:oracleInstanceCredentials" />
<xs:complexType name="virtualInstanceCredentials">
<xs:complexContent mixed="false">
<xs:extension base="tns:instanceCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="virtualServerName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="virtualInstanceCredentials" nillable="true" type="tns:virtualInstanceCredentials" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:simpleType name="SqlServerVersion">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown" />
<xs:enumeration value="SqlServer2005">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2008">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2008R2">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">105</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2012">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2014">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">12</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2016">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">13</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SqlServer2017">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">14</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="SqlServerVersion" nillable="true" type="tns:SqlServerVersion" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql.Base" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Replay.Common.Contracts.Metadata.Sql.Base" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="AvailabilityReplicaRole">
<xs:restriction base="xs:string">
<xs:enumeration value="Resolving" />
<xs:enumeration value="Primary" />
<xs:enumeration value="Secondary" />
</xs:restriction>
</xs:simpleType>
<xs:element name="AvailabilityReplicaRole" nillable="true" type="tns:AvailabilityReplicaRole" />
</xs:schema>
</Schemas>
The following is the response XML Schema:
The response body is empty.