Obter Lista de Informações da Propriedade
Obtém informações sobre todas as propriedades de malha do serviço em um determinado nome.
Um nome de malha do serviço pode ter um ou mais propriedades nomeadas que armazenam informações personalizadas. Esta operação obtém as informações sobre essas propriedades em uma lista de página. As informações incluem o nome, valor e metadados sobre cada uma das propriedades.
Solicitação
| Método | URI da solicitação |
|---|---|
| GET | /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parâmetros
| Nome | Tipo | Obrigatório | Location |
|---|---|---|---|
nameId |
string | Sim | Caminho |
api-version |
string | Sim | Consulta |
IncludeValues |
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.
IncludeValues
Tipo: booliano
Obrigatório: não
Padrão: false
Permite especificar se deseja incluir os valores das propriedades retornadas. Verdadeiro se os valores devem ser retornados com os metadados; Falso para retornar somente metadados de propriedade.
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 propriedades do Service Fabric. |
PagedPropertyInfoList |
| Todos os outros códigos de status | A resposta de erro detalhada. |
FabricError |
Exemplos
Obter lista de informações de propriedade
Este exemplo mostra como obter todas as propriedades do Service Fabric em um determinado nome.
Solicitação
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0
Resposta 200
Corpo
{
"ContinuationToken": "PersistentQueueAppData$131439231986491349",
"IsConsistent": true,
"Properties": [
{
"Name": "CalculatorAppData",
"Metadata": {
"TypeId": "Int64",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
"SequenceNumber": "10"
}
},
{
"Name": "PersistentQueueAppData",
"Metadata": {
"TypeId": "Binary",
"CustomTypeId": "InitializationDataType",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
"SequenceNumber": "12"
}
}
]
}
Obter lista de informações de propriedade com valores
Este exemplo mostra como obter todas as propriedades do Service Fabric e seus valores em um determinado nome.
Solicitação
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True
Resposta 200
Corpo
{
"ContinuationToken": "PersistentQueueAppData$131439231986491349",
"IsConsistent": true,
"Properties": [
{
"Name": "CalculatorAppData",
"Value": {
"Kind": "Int64",
"Data": "4534"
},
"Metadata": {
"TypeId": "Int64",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "8",
"LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
"SequenceNumber": "10"
}
},
{
"Name": "PersistentQueueAppData",
"Value": {
"Kind": "Binary",
"Data": [
"6",
"7",
"8",
"9",
"10"
]
},
"Metadata": {
"TypeId": "Binary",
"CustomTypeId": "InitializationDataType",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "5",
"LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
"SequenceNumber": "12"
}
}
]
}
Página usando token de continuação
Este exemplo mostra como percorrer as informações sobre propriedades 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/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349
Resposta 200
Corpo
{
"ContinuationToken": "",
"IsConsistent": true,
"Properties": [
{
"Name": "VolatileQueueAppData",
"Value": {
"Kind": "Double",
"Data": "67.89"
},
"Metadata": {
"TypeId": "Double",
"CustomTypeId": "",
"Parent": "fabric:/samples/apps",
"SizeInBytes": "8",
"LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
"SequenceNumber": "8"
}
}
]
}