Starta nodövergång
Startar eller stoppar en klusternod.
Startar eller stoppar en klusternod. En klusternod är en process, inte själva OS-instansen. Om du vill starta en nod skickar du "Start" för parametern NodeTransitionType. Om du vill stoppa en nod skickar du "Stopp" för parametern NodeTransitionType. Det här API:et startar åtgärden – när API:et returnerar kanske noden inte har slutfört övergången ännu. Anropa GetNodeTransitionProgress med samma OperationId för att hämta förloppet för åtgärden.
Förfrågan
Metod | URI för förfrågan |
---|---|
POST | /Faults/Nodes/{nodeName}/$/StartTransition/?api-version=6.0&OperationId={OperationId}&NodeTransitionType={NodeTransitionType}&NodeInstanceId={NodeInstanceId}&StopDurationInSeconds={StopDurationInSeconds}&timeout={timeout} |
Parametrar
Namn | Typ | Obligatorisk | Location |
---|---|---|---|
nodeName |
sträng | Ja | Sökväg |
api-version |
sträng | Ja | Söka i data |
OperationId |
sträng (uuid) | Ja | Söka i data |
NodeTransitionType |
sträng (uppräkning) | Ja | Söka i data |
NodeInstanceId |
sträng | Ja | Söka i data |
StopDurationInSeconds |
heltal (int32) | Ja | Söka i data |
timeout |
heltal (int64) | No | Söka i data |
nodeName
Typ: sträng
Obligatoriskt: Ja
Nodens namn.
api-version
Typ: sträng
Obligatoriskt: Ja
Standard: 6.0
Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".
Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.
Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.
OperationId
Typ: sträng (uuid)
Obligatoriskt: Ja
Ett GUID som identifierar ett anrop av det här API:et. Detta skickas till motsvarande GetProgress API
NodeTransitionType
Typ: sträng (uppräkning)
Obligatoriskt: Ja
Anger vilken typ av övergång som ska utföras. NodeTransitionType.Start startar en stoppad nod. NodeTransitionType.Stop stoppar en nod som är igång. Möjliga värden är: 'Ogiltig', 'Start', 'Stop'
NodeInstanceId
Typ: sträng
Obligatoriskt: Ja
Nodinstans-ID för målnoden. Detta kan fastställas via GetNodeInfo API.
StopDurationInSeconds
Typ: heltal (int32)
Obligatoriskt: Ja
InclusiveMinimum: 0
Varaktigheten i sekunder för att hålla noden stoppad. Det minsta värdet är 600, det högsta är 14400. När den här tiden har gått ut kommer noden automatiskt att säkerhetskopieras.
timeout
Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.
Svar
HTTP-statuskod | Description | Svarsschema |
---|---|---|
202 (accepterad) | En statuskod för 202 anger att åtgärden accepterades. Anropa API:et GetNodeTransitionProgress för att hämta förloppet. |
|
Alla andra statuskoder | Det detaljerade felsvaret. |
FabricError |