Compartilhar via

Obter informações da propriedade

  • Artigo

Obtém a propriedade especificada do Service Fabric.

Obtém a propriedade do Service Fabric especificada em um determinado nome. Isso sempre retornará valor e metadados.

Solicitação

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

Parâmetros

Nome Type Obrigatório Location
nameId string Sim Caminho
api-version string Sim Consulta
PropertyName string Sim 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.

PropertyName

Tipo: string
Obrigatório: sim

Especifica o nome da propriedade a ser obtida.

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) Detalhes sobre a propriedade do Service Fabric.
 Propertyinfo
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Obter informações da propriedade

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

Solicitação

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