Obter Lista de Informações do Nó v82
Obtém a lista de nós no cluster do Service Fabric.
A resposta inclui o nome, o estado, o ID, o estado de funcionamento, o tempo de atividade e outros detalhes sobre os nós.
Pedir
Método | URI do pedido |
---|---|
GET | /Nodes?api-version=6.3&ContinuationToken={ContinuationToken}&NodeStatusFilter={NodeStatusFilter}&MaxResults={MaxResults}&timeout={timeout} |
Parâmetros
Nome | Tipo | Necessário | Localização |
---|---|---|---|
api-version |
string | Yes | Consulta |
ContinuationToken |
cadeia (de carateres) | No | Consulta |
NodeStatusFilter |
cadeia (enum) | No | Consulta |
MaxResults |
número inteiro (int64) | No | Consulta |
timeout |
número inteiro (int64) | No | Consulta |
api-version
Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.3
A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de ser "6.3".
A versão da API REST do Service Fabric baseia-se na versão de runtime na qual a API foi introduzida ou foi alterada. O runtime do Service Fabric suporta mais do que uma versão da API. Esta versão é a versão suportada mais recente da API. Se for transmitida uma versão da API inferior, a resposta devolvida poderá ser diferente da documentada nesta especificação.
Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à versão atual do runtime. Por isso, se a versão mais recente da API for 6.0 e o runtime for 6.1, o runtime aceitará a versão 6.1 dessa API. No entanto, o comportamento da API será conforme a versão documentada 6.0.
ContinuationToken
Tipo: cadeia
Obrigatório: Não
O parâmetro do token de continuação é utilizado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio é incluído na resposta da API quando os resultados do sistema não cabem numa única resposta. Quando este valor é transmitido para a próxima chamada à API, a API devolve o próximo conjunto de resultados. Se não existirem mais resultados, o token de continuação não contém um valor. O valor deste parâmetro não deve ser codificado por URL.
NodeStatusFilter
Tipo: cadeia (enum)
Obrigatório: Não
Predefinição: default
Permite filtrar os nós com base no NodeStatus. Só serão devolvidos os nós que correspondem ao valor de filtro especificado. O valor do filtro pode ser um dos seguintes. Os valores possíveis incluem: "predefinição", "all", "up", "down", "enabling", "disabling", "disabled", "unknown", "removed"
MaxResults
Tipo: número inteiro (int64)
Obrigatório: Não
Predefinição: 0
InclusiveMinimum: 0
O número máximo de resultados a devolver como parte das consultas paginadas. Este parâmetro define o limite superior no número de resultados devolvidos. Os resultados devolvidos podem ser inferiores aos resultados máximos especificados se não se ajustarem à mensagem de acordo com as restrições de tamanho máximo da mensagem definidas na configuração. Se este parâmetro for zero ou não for especificado, a consulta paginada inclui o maior número possível de resultados que se enquadram na mensagem de retorno.
timeout
Tipo: número inteiro (int64)
Obrigatório: Não
Predefinição: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
O tempo limite do servidor para executar a operação em segundos. Este tempo limite especifica a duração de tempo que o cliente está disposto a aguardar pela conclusão da operação pedida. O valor predefinido para este parâmetro é 60 segundos.
Respostas
Código de Estado HTTP | Description | Esquema de Resposta |
---|---|---|
200 (OK) | Lista de nós no cluster. |
PagedNodeInfoList |
Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |
Exemplos
Obter informações sobre todos os nós
Este exemplo mostra como obter informações sobre todos os nós no cluster quando as informações se enquadram numa única mensagem de resposta sem a necessidade de paginação através do parâmetro ContinuationToken.
Pedir
GET http://localhost:19080/Nodes?api-version=6.3
Resposta 200
Corpo
{
"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"
}
]
}
Limitar os resultados máximos
Este exemplo mostra como obter informações sobre os nós no cluster quando o número de resultados devolvidos é limitado pelo parâmetro MaxResults.
Pedir
GET http://localhost:19080/Nodes?api-version=6.3&MaxResults=2
Resposta 200
Corpo
{
"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"
}
]
}
Página com o token de continuação
Este exemplo mostra como obter informações sobre nós no cluster que aparecem numa página sequencial com o parâmetro ContinuationToken.
Pedir
GET http://localhost:19080/Nodes?api-version=6.3&ContinuationToken=2acb9f55540659b1c95f27cc128ab326
Resposta 200
Corpo
{
"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"
}
]
}