Obter Lista de Estado de Implantação de Composição

Obtém a lista de implementações de composição criadas no cluster Service Fabric.

Obtém o estado sobre as implementações de composição que foram criadas ou no processo de ser criado no cluster Service Fabric. A resposta inclui o nome, estado e outros detalhes sobre as implementações de composição. Se a lista de implementações não encaixar numa página, uma página de resultados é devolvida, bem como um token de continuação, que pode ser usado para obter a página seguinte.

Pedir

Método URI do pedido
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
api-version string Sim Consulta
ContinuationToken cadeia (de carateres) No Consulta
MaxResults inteiro (int64) Não Consulta
timeout inteiro (int64) Não Consulta

api-version

Tipo: corda
Requerido: Sim
Predefinição: 6.0-preview

A versão da API. Este parâmetro é necessário e o seu valor deve ser "6.0-preview".


ContinuationToken

Tipo: corda
Obrigatório: Não

O parâmetro de token de continuação é usado 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 se enquadram numa única resposta. Quando este valor é passado para a próxima chamada da API, a API devolve o próximo conjunto de resultados. Se não houver mais resultados, então o token de continuação não contém um valor. O valor deste parâmetro não deve ser codificado por URL.


MaxResults

Tipo: inteiro (int64)
Obrigatório: Não
Predefinição: 0
InclusiveMinimum: 0

O número máximo de resultados a devolver como parte das consultas de página. 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 encaixarem na mensagem de acordo com as restrições máximas do tamanho da mensagem definidas na configuração. Se este parâmetro for zero ou não especificado, a consulta paged inclui o maior número possível de resultados que se encaixam na mensagem de retorno.


timeout

Tipo: inteiro (int64)
Obrigatório: Não
Predefinição: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

O tempo limite do servidor para a realização da operação em segundos. Este prazo especifica a duração que o cliente está disposto a esperar pela conclusão da operação solicitada. O valor predefinido para este parâmetro é de 60 segundos.

Respostas

Código de Estado HTTP Descrição Esquema de Resposta
200 (OK) Lista de estatutos de implantações de composição no cluster.
PagedComposeDeploymentStatusInfoList
Todos os outros códigos de estado A resposta detalhada ao erro.
FabricError