Lijst met knooppuntgegevens ophalen v82

Artikel
2023-08-05

Hiermee haalt u de lijst met knooppunten in het Service Fabric-cluster op.

Het antwoord bevat de naam, status, id, status, uptime en andere details over de knooppunten.

Aanvraag

Methode	Aanvraag-URI
GET	`/Nodes?api-version=6.3&ContinuationToken={ContinuationToken}&NodeStatusFilter={NodeStatusFilter}&MaxResults={MaxResults}&timeout={timeout}`

Parameters

Naam	Type	Vereist	Locatie
`api-version`	tekenreeks	Ja	Query’s uitvoeren
`ContinuationToken`	tekenreeks	No	Query’s uitvoeren
`NodeStatusFilter`	tekenreeks (opsomming)	Nee	Query’s uitvoeren
`MaxResults`	geheel getal (int64)	Nee	Query’s uitvoeren
`timeout`	geheel getal (int64)	Nee	Query’s uitvoeren

`api-version`

Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.3

De versie van de API. Deze parameter is vereist en de waarde moet '6.3' zijn.

Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Deze versie is de meest recente ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.

Daarnaast accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is en de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.

`ContinuationToken`

Type: tekenreeks
Vereist: Nee

De vervolgtokenparameter wordt gebruikt om de volgende set resultaten te verkrijgen. Een vervolgtoken met een niet-lege waarde wordt opgenomen in het antwoord van de API wanneer de resultaten van het systeem niet in één antwoord passen. Wanneer deze waarde wordt doorgegeven aan de volgende API-aanroep, retourneert de API de volgende set resultaten. Als er geen verdere resultaten zijn, bevat het vervolgtoken geen waarde. De waarde van deze parameter mag niet worden gecodeerd met een URL.

`NodeStatusFilter`

Type: tekenreeks (opsomming)
Vereist: Nee
Standaardinstelling: default

Hiermee kunt u de knooppunten filteren op basis van de NodeStatus. Alleen de knooppunten die overeenkomen met de opgegeven filterwaarde worden geretourneerd. De filterwaarde kan een van de volgende zijn. Mogelijke waarden zijn: 'default', 'all', 'up', 'down', 'enabling', 'disableing', 'disabled', 'unknown', 'removed'

`MaxResults`

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 0
InclusiefMinimum: 0

Het maximum aantal resultaten dat moet worden geretourneerd als onderdeel van de paginaquery's. Deze parameter definieert de bovengrens voor het aantal geretourneerde resultaten. De geretourneerde resultaten kunnen kleiner zijn dan de opgegeven maximumresultaten als ze niet in het bericht passen volgens de beperkingen voor maximale berichtgrootte die in de configuratie zijn gedefinieerd. Als deze parameter nul is of niet is opgegeven, bevat de wisselquery zoveel mogelijk resultaten die in het retourbericht passen.

`timeout`

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiveMaximum: 4294967295
InclusiefMinimum: 1

De time-out van de server voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten totdat de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.

Antwoorden

HTTP-statuscode	Beschrijving	Antwoordschema
200 (OK)	Lijst met knooppunten in het cluster.	PagedNodeInfoList
Alle andere statuscodes	Het gedetailleerde foutantwoord.	FabricError

Voorbeelden

Informatie over alle knooppunten ophalen

In dit voorbeeld ziet u hoe u informatie over alle knooppunten in het cluster kunt ophalen wanneer de informatie in één antwoordbericht past zonder dat paginering via de parameter ContinuationToken nodig is.

Aanvraag

GET http://localhost:19080/Nodes?api-version=6.3

200-antwoord

Hoofdtekst

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "_Node_1",
      "IpAddressOrFQDN": "10.0.0.5",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "15275",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "1",
      "FaultDomain": "fd:/1",
      "Id": {
        "Id": "ebd986a1134b3643a8117fb41b259bf"
      },
      "InstanceId": "131738274982501335",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T20:31:39.842Z",
      "NodeDownAt": "2018-06-18T20:31:37.374Z"
    },
    {
      "Name": "_Node_0",
      "IpAddressOrFQDN": "10.0.0.4",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "18742",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "0",
      "FaultDomain": "fd:/0",
      "Id": {
        "Id": "2acb9f55540659b1c95f27cc128ab326"
      },
      "InstanceId": "131738240209152398",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T19:33:52.944Z",
      "NodeDownAt": "2018-06-18T19:33:39.514Z"
    },
    {
      "Name": "_Node_4",
      "IpAddressOrFQDN": "10.0.0.8",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "101168",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "4",
      "FaultDomain": "fd:/4",
      "Id": {
        "Id": "ba9383d728221add7fa996bf67b757fb"
      },
      "InstanceId": "131737415865259763",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-17T20:40:07.378Z",
      "NodeDownAt": "2018-06-17T20:33:11.877Z"
    },
    {
      "Name": "_Node_3",
      "IpAddressOrFQDN": "10.0.0.7",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "15236",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "3",
      "FaultDomain": "fd:/3",
      "Id": {
        "Id": "d6a18a0935a3e39aeae2a049eb97255d"
      },
      "InstanceId": "131738275300526952",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T20:32:18.884Z",
      "NodeDownAt": "2018-06-18T20:31:59.128Z"
    },
    {
      "Name": "_Node_2",
      "IpAddressOrFQDN": "10.0.0.6",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "19440",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "2",
      "FaultDomain": "fd:/2",
      "Id": {
        "Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
      },
      "InstanceId": "131738233282843485",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T19:22:15.272Z",
      "NodeDownAt": "2018-06-18T19:22:02.74Z"
    }
  ]
}

Maximum aantal resultaten beperken

In dit voorbeeld ziet u hoe u informatie over de knooppunten in het cluster kunt ophalen wanneer het aantal geretourneerde resultaten wordt beperkt door de parameter MaxResults.

Aanvraag

GET http://localhost:19080/Nodes?api-version=6.3&MaxResults=2

200-antwoord

Hoofdtekst

{
  "ContinuationToken": "2acb9f55540659b1c95f27cc128ab326",
  "Items": [
    {
      "Name": "_testnode_1",
      "IpAddressOrFQDN": "10.0.0.5",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "102016",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "1",
      "FaultDomain": "fd:/1",
      "Id": {
        "Id": "ebd986a1134b3643a8117fb41b259bf"
      },
      "InstanceId": "131738274982501335",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T20:31:39.842Z",
      "NodeDownAt": "2018-06-18T20:31:37.374Z"
    },
    {
      "Name": "_testnode_0",
      "IpAddressOrFQDN": "10.0.0.4",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "105483",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "0",
      "FaultDomain": "fd:/0",
      "Id": {
        "Id": "2acb9f55540659b1c95f27cc128ab326"
      },
      "InstanceId": "131738240209152398",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T19:33:52.944Z",
      "NodeDownAt": "2018-06-18T19:33:39.514Z"
    }
  ]
}

Pagina met vervolgtoken

In dit voorbeeld ziet u hoe u met behulp van de parameter ContinuationToken informatie kunt ophalen over knooppunten in het cluster die op een sequentiële pagina worden weergegeven.

Aanvraag

GET http://localhost:19080/Nodes?api-version=6.3&ContinuationToken=2acb9f55540659b1c95f27cc128ab326

200-antwoord

Hoofdtekst

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "_Node_4",
      "IpAddressOrFQDN": "10.0.0.8",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "101547",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "4",
      "FaultDomain": "fd:/4",
      "Id": {
        "Id": "ba9383d728221add7fa996bf67b757fb"
      },
      "InstanceId": "131737415865259763",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-17T20:40:07.378Z",
      "NodeDownAt": "2018-06-17T20:33:11.877Z"
    },
    {
      "Name": "_Node_3",
      "IpAddressOrFQDN": "10.0.0.7",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "15615",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "3",
      "FaultDomain": "fd:/3",
      "Id": {
        "Id": "d6a18a0935a3e39aeae2a049eb97255d"
      },
      "InstanceId": "131738275300526952",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T20:32:18.884Z",
      "NodeDownAt": "2018-06-18T20:31:59.128Z"
    },
    {
      "Name": "_Node_2",
      "IpAddressOrFQDN": "10.0.0.6",
      "Type": "testnode",
      "CodeVersion": "6.3.139.9494",
      "ConfigVersion": "5",
      "NodeStatus": "Up",
      "NodeUpTimeInSeconds": "19819",
      "HealthState": "Ok",
      "IsSeedNode": true,
      "UpgradeDomain": "2",
      "FaultDomain": "fd:/2",
      "Id": {
        "Id": "f2af91e5e9c8254dedb75b1424a9e3fc"
      },
      "InstanceId": "131738233282843485",
      "NodeDeactivationInfo": {
        "NodeDeactivationIntent": "Invalid",
        "NodeDeactivationStatus": "None",
        "NodeDeactivationTask": [],
        "PendingSafetyChecks": []
      },
      "IsStopped": false,
      "NodeDownTimeInSeconds": "0",
      "NodeUpAt": "2018-06-18T19:22:15.272Z",
      "NodeDownAt": "2018-06-18T19:22:02.74Z"
    }
  ]
}

Delen via

Lijst met knooppuntgegevens ophalen v82

Aanvraag

Parameters

api-version

ContinuationToken

NodeStatusFilter

MaxResults

timeout

Antwoorden

Voorbeelden

Informatie over alle knooppunten ophalen

Aanvraag

200-antwoord

Hoofdtekst

Maximum aantal resultaten beperken

Aanvraag

200-antwoord

Hoofdtekst

Pagina met vervolgtoken

Aanvraag

200-antwoord

Hoofdtekst

Aanvullende resources

`api-version`

`ContinuationToken`

`NodeStatusFilter`

`MaxResults`

`timeout`