Share via


Obter Lista de Status de Implantação do Compose

Obtém a lista de implantação de composição criada no cluster do Service Fabric.

Obtém o status sobre as implantações de redação que foram criadas ou no processo de criação do cluster do Service Fabric. A resposta inclui o nome, o status e outros detalhes sobre a implantação de composição. Se a lista de implantações não couber em uma página, uma página de resultados é retornada, bem como um token de continuação que pode ser usado para a próxima página.

Solicitação

Método URI da solicitação
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

Nome Type Obrigatório Location
api-version string Sim Consulta
ContinuationToken string No Consulta
MaxResults inteiro (int64) No Consulta
timeout inteiro (int64) No Consulta

api-version

Tipo: string
Obrigatório: sim
Padrão: 6.0-preview

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


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.


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.


timeout

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tempo limite do servidor para executar a operação em segundos. Especifica o tempo que o cliente está disposto a esperar para que operação solicitada seja concluída. O valor padrão desse parâmetro é 60 segundos.

Respostas

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