Obter Informações de Propriedade

  • Artigo

Obtém a propriedade do Service Fabric especificada.

Obtém a propriedade do Service Fabric especificada com um determinado nome. Isto devolverá sempre o valor e os metadados.

Pedir

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

Parâmetros

Nome Tipo Necessário Localização
nameId string Yes Caminho
api-version string Yes Consulta
PropertyName string Yes Consulta
timeout número inteiro (int64) No Consulta

nameId

Tipo: cadeia
Obrigatório: Sim

O nome do Service Fabric, sem o esquema de 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 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 inferior da API, 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. Por isso, se a versão mais recente da API for a 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á de acordo com a versão 6.0 documentada.

PropertyName

Tipo: cadeia
Obrigatório: Sim

Especifica o nome da propriedade a obter.

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 que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Detalhes sobre a propriedade do Service Fabric.
 PropertyInfo
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Obter informações de propriedade

Este exemplo mostra como obter uma propriedade do Service Fabric com um determinado nome.

Pedir

GET http://localhost:19080/Names/samples/apps/$/GetProperty?api-version=6.0&PropertyName=AppData

Resposta 200

Corpo
{
  "Name": "CalculatorAppData",
  "Value": {
    "Kind": "String",
    "Data": "1+2=3"
  },
  "Metadata": {
    "TypeId": "String",
    "CustomTypeId": "EquationType",
    "Parent": "fabric:/samples/apps",
    "SizeInBytes": "12",
    "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
    "SequenceNumber": "12"
  }
}