Obter Segmento de Estado de Funcionamento do Cluster com a Política e Filtros Avançados
Obtém o estado de funcionamento de um cluster do Service Fabric através de segmentos de estado de funcionamento.
Obtém o estado de funcionamento de um cluster do Service Fabric através de segmentos de estado de funcionamento. A avaliação do estado de funcionamento é feita com base na descrição da consulta do segmento de estado de funcionamento do cluster de entrada. A descrição da consulta permite que os utilizadores especifiquem políticas de estado de funcionamento para avaliar o cluster e os respetivos subordinados. Os utilizadores podem especificar filtros muito flexíveis para selecionar as entidades de cluster a devolver. A seleção pode ser feita com base no estado de funcionamento das entidades e com base na hierarquia. A consulta pode devolver subordinados de vários níveis das entidades com base nos filtros especificados. Por exemplo, pode devolver uma aplicação com um nome especificado e, para esta aplicação, devolver apenas os serviços que se encontram em Erro ou Aviso e todas as partições e réplicas de um destes serviços.
Pedir
Método | URI do pedido |
---|---|
POST | /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout} |
Parâmetros
Nome | Tipo | Necessário | Localização |
---|---|---|---|
api-version |
string | Yes | Consulta |
timeout |
número inteiro (int64) | No | Consulta |
ClusterHealthChunkQueryDescription |
ClusterHealthChunkQueryDescription | No | Corpo |
api-version
Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.0
A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de ser "6.0".
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 é 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. Portanto, se a versão mais recente da API for 6.0, mas se o runtime for 6.1, para facilitar a escrita dos clientes, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será conforme a versão documentada 6.0.
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.
ClusterHealthChunkQueryDescription
Tipo: ClusterHealthChunkQueryDescription
Obrigatório: Não
Descreve as políticas de estado de funcionamento do cluster e da aplicação utilizadas para avaliar o estado de funcionamento do cluster e os filtros para selecionar as entidades de cluster a devolver.
Se a política de estado de funcionamento do cluster estiver presente, é utilizada para avaliar os eventos do cluster e os nós de cluster. Se não estiver presente, a avaliação do estado de funcionamento utiliza a política de estado de funcionamento do cluster definida no manifesto do cluster ou na política de estado de funcionamento do cluster predefinida.
Por predefinição, cada aplicação é avaliada com a política de estado de funcionamento da aplicação específica, definida no manifesto da aplicação ou a política de estado de funcionamento predefinida, se nenhuma política for definida no manifesto.
Se o mapa da política de estado de funcionamento da aplicação for especificado e tiver uma entrada para uma aplicação, a política de estado de funcionamento da aplicação especificada é utilizada para avaliar o estado de funcionamento da aplicação.
Os utilizadores podem especificar filtros muito flexíveis para selecionar que entidades de cluster incluir em resposta. A seleção pode ser feita com base no estado de funcionamento das entidades e com base na hierarquia.
A consulta pode devolver subordinados de vários níveis das entidades com base nos filtros especificados. Por exemplo, pode devolver uma aplicação com um nome especificado e, para esta aplicação, devolver apenas os serviços que se encontram em Erro ou Aviso e todas as partições e réplicas de um destes serviços.
Respostas
Código de Estado HTTP | Description | Esquema de Resposta |
---|---|---|
200 (OK) | Uma operação bem-sucedida devolverá o código de estado 200 e as informações do segmento de estado de funcionamento do cluster pedidas. |
ClusterHealthChunk |
Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |