API Documentation

Last Update: 28 December 2022

POST api/HostMSSQLAvailabilityReplica



Request Information


URI Parameters

None.


Body Parameters
HostMSSQLAvailabilityReplica
Name Description Type Additional information
ID

integer

None.
ReportDate

date

None.
HostID

integer

None.
Name

string

None.
InstanceName

string

None.
AvailabilityReplicaGuid

string

None.
AvailabilityGroupGuid

string

None.
AvailabilityGroupName

string

None.
Role

string

None.
AvailabilityMode

string

None.
ConnectionModeInPrimaryRole

string

None.
ConnectionModeInSecondaryRole

string

None.
EndpointUrl

string

None.
FailoverMode

string

None.
JoinState

string

None.
QuorumVoteCount

integer

None.
SessionTimeout

integer

None.
BackupPriority

integer

None.
CreateDate

date

None.
DateLastModified

date

None.
RecordStatus

integer

None.
Request Formats
application/json, text/json
Sample: 
{
  "ID": 1,
  "ReportDate": "2024-11-21T06:21:14.4066361+00:00",
  "HostID": 3,
  "Name": "sample string 4",
  "InstanceName": "sample string 5",
  "AvailabilityReplicaGuid": "sample string 6",
  "AvailabilityGroupGuid": "sample string 7",
  "AvailabilityGroupName": "sample string 8",
  "Role": "sample string 9",
  "AvailabilityMode": "sample string 10",
  "ConnectionModeInPrimaryRole": "sample string 11",
  "ConnectionModeInSecondaryRole": "sample string 12",
  "EndpointUrl": "sample string 13",
  "FailoverMode": "sample string 14",
  "JoinState": "sample string 15",
  "QuorumVoteCount": 16,
  "SessionTimeout": 17,
  "BackupPriority": 18,
  "CreateDate": "2024-11-21T06:21:14.4066361+00:00",
  "DateLastModified": "2024-11-21T06:21:14.4066361+00:00",
  "RecordStatus": 21
}

Response Information


Resource Description
HostMSSQLAvailabilityReplica
Name Description Type Additional information
ID

integer

None.
ReportDate

date

None.
HostID

integer

None.
Name

string

None.
InstanceName

string

None.
AvailabilityReplicaGuid

string

None.
AvailabilityGroupGuid

string

None.
AvailabilityGroupName

string

None.
Role

string

None.
AvailabilityMode

string

None.
ConnectionModeInPrimaryRole

string

None.
ConnectionModeInSecondaryRole

string

None.
EndpointUrl

string

None.
FailoverMode

string

None.
JoinState

string

None.
QuorumVoteCount

integer

None.
SessionTimeout

integer

None.
BackupPriority

integer

None.
CreateDate

date

None.
DateLastModified

date

None.
RecordStatus

integer

None.
Response Formats
application/json, text/json
Sample: 
{
  "ID": 1,
  "ReportDate": "2024-11-21T06:21:14.4131813+00:00",
  "HostID": 3,
  "Name": "sample string 4",
  "InstanceName": "sample string 5",
  "AvailabilityReplicaGuid": "sample string 6",
  "AvailabilityGroupGuid": "sample string 7",
  "AvailabilityGroupName": "sample string 8",
  "Role": "sample string 9",
  "AvailabilityMode": "sample string 10",
  "ConnectionModeInPrimaryRole": "sample string 11",
  "ConnectionModeInSecondaryRole": "sample string 12",
  "EndpointUrl": "sample string 13",
  "FailoverMode": "sample string 14",
  "JoinState": "sample string 15",
  "QuorumVoteCount": 16,
  "SessionTimeout": 17,
  "BackupPriority": 18,
  "CreateDate": "2024-11-21T06:21:14.4131813+00:00",
  "DateLastModified": "2024-11-21T06:21:14.4131813+00:00",
  "RecordStatus": 21
}