Obter Lista de Informações de Propriedade
Obtém informações sobre todas as propriedades do Service Fabric com um determinado nome.
Um nome do Service Fabric pode ter uma ou mais propriedades nomeadas que armazenam informações personalizadas. Esta operação obtém as informações sobre estas propriedades numa lista paginada. As informações incluem nome, valor e metadados sobre cada uma das propriedades.
Pedir
| Método | URI do pedido |
|---|---|
| GET | /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parâmetros
| Nome | Tipo | Necessário | Localização |
|---|---|---|---|
nameId |
string | Yes | Caminho |
api-version |
string | Yes | Consulta |
IncludeValues |
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.
IncludeValues
Tipo: booleano
Obrigatório: Não
Predefinição: false
Permite especificar se deve incluir os valores das propriedades devolvidas. True if values should be returned with the metadata; Falso para devolver apenas metadados de propriedade.
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 das propriedades do Service Fabric. |
PagedPropertyInfoList |
| Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |
Exemplos
Obter lista de informações de propriedades
Este exemplo mostra como obter todas as propriedades do Service Fabric com um determinado nome.
Pedir
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 propriedades com valores
Este exemplo mostra como obter todas as propriedades do Service Fabric e os respetivos valores com um determinado nome.
Pedir
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 com o token de continuação
Este exemplo mostra como analisar as informações sobre as propriedades 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/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"
}
}
]
}