Свойство Put
Создает или обновляет свойство Service Fabric.
Создает или обновляет указанное свойство Service Fabric с указанным именем.
Запрос
Метод | Универсальный код ресурса (URI) запроса |
---|---|
PUT | /Names/{nameId}/$/GetProperty?api-version=6.0&timeout={timeout} |
Параметры
Имя | Тип | Обязательно | Расположение |
---|---|---|---|
nameId |
строка | Да | Путь |
api-version |
строка | Да | Запрос |
timeout |
целое число (int64) | Нет | Запрос |
PropertyDescription |
PropertyDescription | да | Текст |
nameId
Тип: строка
Обязательный: да
Имя Service Fabric без указания схемы универсального кода ресурса (URI) "fabric:".
api-version
Тип: строка
Обязательный: да
По умолчанию: 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.
timeout
Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.
PropertyDescription
Тип: PropertyDescription
Обязательный: да
Описывает создаваемое свойство Service Fabric.
Ответы
Код состояния HTTP | Описание | схеме ответа. |
---|---|---|
200 OK; | Успешный ответ означает, что свойство было создано или обновлено. |
|
Все остальные коды состояния | Подробный ответ об ошибке. |
FabricError |
Примеры
Свойство Put
В этом примере показано, как создать или обновить свойство Service Fabric под заданным именем.
Запрос
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Текст
{
"PropertyName": "AppData",
"Value": {
"Kind": "Binary",
"Data": [
"0",
"1",
"2",
"3",
"4",
"5"
]
}
}
Ответ 200
Текст
Текст ответа пуст.
Пользовательское свойство Put
В этом примере показано, как создать или обновить свойство Service Fabric под заданным именем с пользовательским типом.
Запрос
PUT http://localhost:19080/Names/samples/apps/CalculatorApp/$/GetProperty?api-version=6.0
Текст
{
"PropertyName": "AppData",
"Value": {
"Kind": "String",
"Data": "1+2=3"
},
"CustomTypeId": "EquationType"
}
Ответ 200
Текст
Текст ответа пуст.