Obter Lista de Estados de Implementação de Composição

  • Artigo

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

Obtém o estado sobre as implementações de composição que foram criadas ou no processo de criação no cluster do Service Fabric. A resposta inclui o nome, o estado e outros detalhes sobre as implementações de composição. Se a lista de implementações não caber numa página, é devolvida uma página de resultados, bem como um token de continuação, que pode ser utilizado 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 Yes Consulta
ContinuationToken cadeia (de carateres) 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.0-preview

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de ser "6.0-preview".

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.

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 caberem na mensagem de acordo com as restrições de tamanho máximo de mensagens 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 cabem 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 que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

Respostas

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