Obter lista de informações de partição carregada

Artigo
08/05/2023

Obtém a lista ordenada de partições.

Recupera partições que são mais/menos carregadas de acordo com a métrica especificada.

Solicitação

Método	URI da solicitação
GET	`/$/GetLoadedPartitionInfoList?api-version=8.0&MetricName={MetricName}&ServiceName={ServiceName}&Ordering={Ordering}&MaxResults={MaxResults}&ContinuationToken={ContinuationToken}`

Parâmetros

Nome	Tipo	Obrigatório	Location
`api-version`	string	Sim	Consulta
`MetricName`	string	Sim	Consulta
`ServiceName`	string	Não	Consulta
`Ordering`	cadeia de caracteres (enumeração)	Não	Consulta
`MaxResults`	inteiro (int64)	Não	Consulta
`ContinuationToken`	string	Não	Consulta

`api-version`

Tipo: string
Obrigatório: sim
Padrão: 8.0

A versão da API. Esse parâmetro é necessário e seu valor deve ser '8.0'.

A versão da API REST do Service Fabric é baseada na versão de runtime na qual a API foi introduzida ou alterada. O runtime do Service Fabric dá suporte a mais de uma versão da API. Esta versão é a versão mais recente com suporte da API. Se uma versão inferior da API for passada, a resposta retornada poderá ser diferente daquela documentada nessa especificação.

Além disso, o runtime aceita qualquer versão maior que a versão mais recente com suporte até a versão atual do runtime. Portanto, 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 para essa API. No entanto, o comportamento da API será de acordo com a versão documentada 6.0.

`MetricName`

Tipo: string
Obrigatório: sim

Nome da métrica com base na qual obter a lista ordenada de partições.

`ServiceName`

Tipo: string
Obrigatório: não

O nome de um serviço.

`Ordering`

Tipo: cadeia de caracteres (enumeração)
Obrigatório: não
Padrão: Desc

Ordenação da carga das partições. Os valores possíveis incluem: 'Desc', 'Asc'

`MaxResults`

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 0
InclusiveMinimum: 0

O número máximo de resultados a serem retornados como parte das consultas paginadas. Esse parâmetro define o limite superior no número de resultados retornados. Os resultados retornados podem ser inferiores aos resultados máximos especificados se não couberem na mensagem, de acordo com as restrições de tamanho máximo de mensagem definidas na configuração. Se esse parâmetro for zero, ou não for especificado, a consulta paginada incluirá o máximo de resultados possível na mensagem de retorno.

`ContinuationToken`

Tipo: string
Obrigatório: não

O parâmetro do token de continuação é usado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio será incluso na resposta da API quando os resultados do sistema não couberem em uma única resposta. Quando esse valor for passado para a próxima chamada de API, a API retornará o próximo conjunto de resultados. Se não houver mais resultados, o token de continuação não conterá um valor. O valor desse parâmetro não deve ser codificado em URL.

Respostas

Código de status HTTP	Descrição	Esquema de Resposta
200 (OK)	Uma operação bem-sucedida retornará 200 status código e as informações de carregamento do cluster solicitadas.	LoadedPartitionInformationResultList
Todos os outros códigos status	A resposta de erro detalhada.	FabricError

Share via