Compartilhar via

Obter lista de informações de subnomesta

  • Artigo

Enumera todos os nomes do Service Fabric em um determinado nome.

Enumera todos os nomes do Service Fabric em um determinado nome. Se os sub-nomes não se ajustarem a uma página, uma página de resultados será retornada, bem como um token de continuação, que pode ser usado para obter a próxima página. A consulta de um nome que não existe falhará.

Solicitação

Método URI da solicitação
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parâmetros

Nome Tipo Obrigatório Location
nameId string Sim Caminho
api-version string Sim Consulta
Recursive booleano Não Consulta
ContinuationToken string Não Consulta
timeout inteiro (int64) Não Consulta

nameId

Tipo: string
Obrigatório: sim

Nome da malha do serviço, sem o ' malha:' esquema de URI.

api-version

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

A versão da API. Esse parâmetro é necessário e seu valor deve 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 dá suporte a mais de uma versão da API. Esta é 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 nesta especificação.

Além disso, o runtime aceita qualquer versão que seja maior do 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, mas se o runtime for 6.1, para facilitar a gravação dos clientes, 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.

Recursive

Tipo: booliano
Obrigatório: não
Padrão: false

Permite especificar que a pesquisa executada deve ser recursiva.

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.

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) Uma lista paginada de nomes do Service Fabric.
 PagedSubNameInfoList
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Obter sub-nomes

Este exemplo mostra como obter informações sobre todos os sub-nomes de um determinado nome do Service Fabric.

Solicitação

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

Pesquisar sub-nomes recursivamente

Este exemplo mostra como obter recursivamente informações sobre todos os sub-nomes filho de um determinado nome do Service Fabric.

Solicitação

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

Página usando token de continuação

Este exemplo mostra como percorrer as informações sobre sub-nomes em um determinado nome do Service Fabric usando o parâmetro ContinuationToken. O valor desse parâmetro é fornecido da consulta anterior, nesse caso, o exemplo mostrado acima. A resposta contém os dois resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que resultados adicionais não estão disponíveis.

Solicitação

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}