Получение сведений о свойстве

  • Статья

Возвращает указанное свойство Service Fabric.

Возвращает указанное свойство Service Fabric с указанным именем. Всегда будет возвращать значение и метаданные.

Запрос

Метод Универсальный код ресурса (URI) запроса
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

Параметры

Имя Тип Обязательно Расположение
nameId строка Да Путь
api-version строка Да Запрос
PropertyName строка Да Запрос
timeout integer (int64) Нет Запрос

nameId

Тип: string
Обязательный: да

Имя Service Fabric без указания схемы универсального кода ресурса (URI) "fabric:".

api-version

Тип: string
Обязательный: да
По умолчанию: 6.0

Версия API. Этот параметр является обязательным и его значение должно быть "6.0".

Версия REST API Service Fabric основана на версии среды выполнения, в которой api был представлен или был изменен. Среда выполнения Service Fabric поддерживает несколько версий API. Это последняя поддерживаемая версия API. Если передается более ранжная версия API, возвращаемый ответ может отличаться от ответа, описанного в этой спецификации.

Кроме того, среда выполнения принимает любую версию, которая выше последней поддерживаемой версии, вплоть до текущей версии среды выполнения. Таким образом, если последняя версия API — 6.0, а среда выполнения — 6.1, чтобы упростить запись клиентов, среда выполнения примет версию 6.1 для этого API. Однако поведение API будет выполняться в документе версии 6.0.

PropertyName

Тип: string
Обязательный: да

Указывает имя возвращаемого свойства.

timeout

Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.

Ответы

Код состояния HTTP Описание схеме ответа.
200 OK; Сведения о свойстве Service Fabric.
 Propertyinfo
Все остальные коды состояния Подробный ответ об ошибке.
 FabricError

Примеры

Получение сведений о свойстве

В этом примере показано, как получить свойство Service Fabric с заданным именем.

Запрос

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

Ответ 200

Текст
{
  "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"
  }
}