Partilhar via

Obter Lista de Informações de Sub-Nome

  • Artigo

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

Enumera todos os nomes do Service Fabric com um determinado nome. Se os subnames não caberem 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. A consulta de um nome que não existe irá falhar.

Pedir

Método URI do pedido
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
nameId string Yes Caminho
api-version string Yes Consulta
Recursive boolean No Consulta
ContinuationToken cadeia (de carateres) No Consulta
timeout número inteiro (int64) No Consulta

nameId

Tipo: cadeia
Obrigatório: Sim

O nome do Service Fabric, sem o esquema URI "fabric:".

api-version

Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.0

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 suporta mais do que uma versão da API. Esta é a versão suportada mais recente da API. Se for transmitida uma versão da API inferior, a resposta devolvida poderá ser diferente da documentada nesta especificação.

Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à 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 escrita dos clientes, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será conforme a versão documentada 6.0.

Recursive

Tipo: booleano
Obrigatório: Não
Predefinição: false

Permite especificar que a pesquisa realizada deve ser recursiva.

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.

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 pela conclusão da operação pedida. O valor predefinido para este parâmetro é 60 segundos.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Uma lista paginada de nomes do Service Fabric.
 PagedSubNameInfoList
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Obter sub-nomes

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

Pedir

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

Resposta 200

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

Procurar sub-nomes de forma recursiva

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

Pedir

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 com o token de continuação

Este exemplo mostra como analisar as informações sobre sub-nomes num determinado nome do Service Fabric com o parâmetro ContinuationToken. O valor deste parâmetro é fornecido a partir da consulta anterior, neste caso, o exemplo apresentado acima. A resposta contém os dois resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que não estão disponíveis resultados adicionais.

Pedir

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"
  ]
}