Поделиться через

Получение списка сведений о свойствах

  • Статья

Возвращает информацию обо всех свойствах Service Fabric с указанным именем.

Имя Service Fabric может иметь одно или несколько именованных свойств для хранения пользовательской информации. Эта операция возвращает информацию об этих свойствах в списке, разбитом на страницы. Информация включает имя, значение и метаданные о каждом из свойств.

Запрос

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

Параметры

Имя Тип Обязательно Расположение
nameId строка Да Путь
api-version строка Да Запрос
IncludeValues Логическое Нет Запрос
ContinuationToken строка Нет Запрос
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.

IncludeValues

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

Позволяет указывать, следует ли включать значения возвращаемых свойств. Если значения необходимо возвращать с метаданными, устанавливается значение true. Чтобы возвращать только метаданные свойства, устанавливается значение false.

ContinuationToken

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

Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса.

timeout

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

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

Ответы

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

Примеры

Получение списка сведений о свойствах

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

Запрос

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0

Ответ 200

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

Получение списка сведений о свойствах со значениями

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

Запрос

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True

Ответ 200

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

Страница с использованием маркера продолжения

В этом примере показано, как просмотреть сведения о свойствах под заданным именем Service Fabric с помощью параметра ContinuationToken. Значение этого параметра предоставляется из предыдущего запроса, в данном случае в приведенном выше примере. Ответ содержит оставшиеся два результата и пустой элемент ContinuationToken. Пустой элемент ContinuationToken указывает, что дополнительные результаты недоступны.

Запрос

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349

Ответ 200

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