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


sfctl service

Создание и удаление служб, типов служб и пакетов службы, а также управление ими.

Команды

Команда Description
app-name Возвращает имя приложения Service Fabric для службы.
code-package-list Возвращает список пакетов кода, развернутых на узле Service Fabric.
create Создает указанную службу Service Fabric.
удалить Удаляет существующую службу Service Fabric.
deployed-type Возвращает сведения об указанном типе службы приложения, развернутого на узле в кластере Service Fabric.
deployed-type-list Возвращает список, содержащий сведения о типах служб из приложений, развернутых на узле в кластере Service Fabric.
описание Возвращает описание существующей службы Service Fabric.
get-container-logs Возвращает журналы контейнера, развернутого на узле Service Fabric.
Здравоохранение Возвращает состояние работоспособности указанной службы Service Fabric.
info Возвращает сведения об указанной службе, относящейся к приложению Service Fabric.
список Возвращает сведения обо всех службах, относящихся к приложению, указанному с помощью идентификатора приложения.
manifest Возвращает манифест, описывающий тип службы.
package-deploy Скачивает пакеты, связанные с указанным манифестом службы, в кэш образов на указанном узле.
package-health Возвращает сведения о работоспособности пакета службы для указанного приложения, развернутого на узле Service Fabric.
package-info Возвращает список пакетов службы, развернутых на узле Service Fabric, имя которых точно совпадает с указанным значением.
package-list Возвращает список пакетов службы, развернутых на узле Service Fabric.
восстановление Указывает кластеру Service Fabric, что следует попытаться восстановить указанную службу, которая находится в состоянии потери кворума.
report-health Отправляет отчет о работоспособности службы Service Fabric.
resolve Разрешает секцию Service Fabric.
type-list Возвращает список, содержащий сведения о типах служб, поддерживаемых подготовленным типом приложения в кластере Service Fabric.
обновить Обновляет указанную службу с помощью заданного описания обновления.

sfctl service app-name

Возвращает имя приложения Service Fabric для службы.

Возвращает имя приложения для указанной службы. Возвращается ошибка "404 FABRIC_E_SERVICE_DOES_NOT_EXIST", если служба с указанным идентификатором службы не существует.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service code-package-list

Возвращает список пакетов кода, развернутых на узле Service Fabric.

Возвращает список пакетов кода, развернутых на узле Service Fabric для указанного приложения.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--code-package-name Имя пакета кода, указанное в манифесте службы и зарегистрированное для типа приложения в кластере Service Fabric.
--service-manifest-name Имя манифеста службы, зарегистрированное для типа приложения в кластере Service Fabric.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service create

Создает указанную службу Service Fabric.

Аргументы

Аргумент Description
--app-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0 иерархические имена разделяются знаком "~". Например, если имя приложения fabric:/myapp/app1, то в версии 6.0 и более поздних версиях идентификатором приложения будет myapp~app1, а в предыдущих версиях идентификатором был бы myapp/app1.
--name [обязательный параметр] Имя службы. Она должна быть дочерним элементом по отношению к идентификатору приложения. Это полное имя, включая универсальный код ресурса (URI) fabric\:. Например, служба fabric\:/A/B является дочерней для приложения fabric\:/A.
--service-type [обязательный параметр] Имя типа службы.
--activation-mode Режим активации пакета службы.
--constraints Ограничения размещения в виде строки. Ограничения размещения — это логические выражения, которые позволяют на основе свойств узла ограничить размещение службы определенными узлами в соответствии с требованиями этой службы. Например, чтобы разместить службу на узлах, у которых NodeType имеет значение blue, укажите "NodeColor == blue".
--correlated-service Имя целевой службы для сопоставления.
--correlation Сопоставление службы с существующей службой с помощью сходства расположения.
--dns-name DNS-имя создаваемой службы. Для использования этого параметра необходимо включить системную службу DNS Service Fabric.
--instance-count Число экземпляров. Это значение относится к службам без отслеживания состояния.
--int-scheme Указывает, что служба должна быть равномерно секционирована в диапазоне целых чисел без знака.
--int-scheme-count Количество секций, создаваемых в диапазоне целочисленных ключей, если используется схема равномерного секционирования по целым числам.
--int-scheme-high Конец диапазона целочисленных ключей, если используется схема равномерного секционирования по целым числам.
--int-scheme-low Начало диапазона целочисленных ключей, если используется схема равномерного секционирования по целым числам.
--load-metrics Список метрик, используемых при балансировке нагрузки служб на узлах, в формате JSON.
--min-replica-set-size Минимальный размер набора реплик в виде числа. Это значение относится только к службам без отслеживания состояния.
--move-cost Указывает стоимость перемещения для службы. Возможные значения: Zero (Нулевая), Low (Низкая), Medium (Средняя), High (Высокая), VeryHigh (Очень высокая).
--named-scheme Указывает, что служба должна иметь несколько именованных секций.
--named-scheme-list Список имен для секционирования службы, указанный в формате JSON, если используется схема секционирования с именованием.
--no-persisted-state Если задано значение true, состояние службы не хранится на локальном диске или хранится только в памяти.
--placement-policy-list Список политик размещения для службы в формате JSON, а также связанные доменные имена. Может использоваться одна или несколько следующих политик: NonPartiallyPlaceService, PreferPrimaryDomain, RequireDomain, RequireDomainDistribution.
--quorum-loss-wait Максимальный интервал времени в секундах, в течение которого секция может находиться в состоянии потери кворума. Это значение относится только к службам без отслеживания состояния.
--replica-restart-wait Интервал времени в секундах, по истечении которого после выхода из строя реплики создается новая реплика. Это значение относится только к службам без отслеживания состояния.
--scaling-policies Список политик масштабирования для службы, указанный в формате JSON.
--service-placement-time Время, в течение которого реплики могут сохранять состояние InBuild, прежде чем будет отправлено оповещение о зависании сборки. Это значение относится только к службам без отслеживания состояния.
--singleton-scheme Указывает, что у службы должна быть одна секция или секционирование не должно применяться.
--stand-by-replica-keep Максимальный интервал времени в секундах, на протяжении которого сохраняются резервные реплики, прежде чем они будут удалены. Это значение относится только к службам без отслеживания состояния.
--stateful Указывает, что служба отслеживает состояние.
--stateless Указывает, что служба не отслеживает состояние.
--target-replica-set-size Размер целевого набора реплик в виде числа. Это значение относится только к службам без отслеживания состояния.
--timeout -t Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service delete

Удаляет существующую службу Service Fabric.

Служба должна быть создана, прежде чем ее можно будет удалить. По умолчанию Service Fabric попытается нормально закрыть реплики службы, а затем удалит службу. Но если из-за проблем в работе службы нормально закрыть реплики не удается, операция удаления может занять много времени или зависнуть. Используйте необязательный флаг ForceRemove, чтобы пропустить последовательность нормального закрытия и принудительно удалить службу.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--force-remove Принудительное удаление приложения или службы Service Fabric без выполнения последовательности нормального завершения работы. Этот параметр можно использовать, чтобы принудительно удалить приложение или службу, срок удаления которой истек из-за проблем в коде службы, которые мешают нормальному закрытию реплик.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service deployed-type

Возвращает сведения об указанном типе службы приложения, развернутого на узле в кластере Service Fabric.

Возвращает список, содержащий сведения об указанном типе служб из приложений, развернутых на узле в кластере Service Fabric. Ответ включает имя типа службы, его состояние регистрации, пакет кода, который его зарегистрировал и идентификатор активации пакета службы. Каждая запись представляет одну активацию для типа службы с уникальным идентификатором активации.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--service-type-name [обязательный параметр] Задает имя для типа службы Service Fabric.
--service-manifest-name Имя манифеста службы, по которому фильтруется список типов развернутых служб. Если указан этот параметр, ответ будет содержать сведения только о службах тех типов, которые определены в указанном манифесте службы.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service deployed-type-list

Возвращает список, содержащий сведения о типах служб из приложений, развернутых на узле в кластере Service Fabric.

Возвращает список, содержащий сведения о типах служб из приложений, развернутых на узле в кластере Service Fabric. Ответ включает имя типа службы, его состояние регистрации, пакет кода, который его зарегистрировал и идентификатор активации пакета службы.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--service-manifest-name Имя манифеста службы, по которому фильтруется список типов развернутых служб. Если указан этот параметр, ответ будет содержать сведения только о службах тех типов, которые определены в указанном манифесте службы.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service description

Возвращает описание существующей службы Service Fabric.

Возвращает описание существующей службы Service Fabric. Служба должна быть создана, прежде чем можно будет извлечь ее описание.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service get-container-logs

Возвращает журналы контейнера, развернутого на узле Service Fabric.

Возвращает журналы контейнера, развернутого на узле Service Fabric для указанного пакета кода.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--code-package-name [обязательный параметр] Имя пакета кода, указанное в манифесте службы и зарегистрированное для типа приложения в кластере Service Fabric.
--node-name [обязательный параметр] Имя узла.
--service-manifest-name [обязательный параметр] Имя манифеста службы, зарегистрированное для типа приложения в кластере Service Fabric.
--previous Указывает, нужно ли получать журналы контейнера для завершенных и (или) неиспользуемых контейнеров в экземпляре пакета кода.
--tail Число отображаемых строк из конца указанных журналов. Количество по умолчанию — 100. Значение all отображает полные журналы.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service health

Возвращает состояние работоспособности указанной службы Service Fabric.

Возвращает сведения о работоспособности указанной службы. EventsHealthStateFilter используется для фильтрации получаемой коллекции событий работоспособности службы на основе состояния работоспособности. PartitionsHealthStateFilter используется для фильтрации возвращаемой коллекции секций. Если указанная служба не существует в хранилище данных о работоспособности, то этот запрос возвращает ошибку.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--events-health-state-filter Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "OK" (2) и "Warning" (4).
-Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
-None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
-OK — фильтр, извлекающий входные данные с HealthState со значением "OK". Значение равно 2.
-Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4.
-Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8.
-All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65535.
--exclude-health-statistics Указывает, должна ли возвращаться статистика работоспособности в составе результатов запроса. Значение по умолчанию: false. Статистика содержит число дочерних сущностей в состоянии работоспособности OK, Warning и Error.
--partitions-health-state-filter Позволяет фильтровать объекты состояния работоспособности секций, возвращаемые в результате запроса работоспособности службы, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те секции, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все секции. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисления на основе флага. Поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращается состояние работоспособности секций со значениями HealthState "ОК" (2) и "Warning" (4).
-Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
-None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
-OK — фильтр, извлекающий входные данные с HealthState со значением "OK". Значение равно 2.
-Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4.
-Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8.
-All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65535.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service info

Возвращает сведения об указанной службе, относящейся к приложению Service Fabric.

Возвращает сведения об указанной службе, относящейся к указанному приложению Service Fabric.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service list

Возвращает сведения обо всех службах, относящихся к приложению, указанному с помощью идентификатора приложения.

Извлекает сведения обо всех службах, относящихся к приложению, указанному с помощью идентификатора приложения.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--continuation-token Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса.
--service-type-name Имя типа службы, используемое для фильтрации запрашиваемых служб.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service manifest

Возвращает манифест, описывающий тип службы.

Возвращает манифест, описывающий тип службы. Ответ содержит XML манифеста службы в виде строки.

Аргументы

Аргумент Description
--application-type-name [обязательный параметр] Имя типа приложения.
--application-type-version [обязательный параметр] Версия типа приложения.
--service-manifest-name [обязательный параметр] Имя манифеста службы, зарегистрированное для типа приложения в кластере Service Fabric.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service package-deploy

Скачивает пакеты, связанные с указанным манифестом службы, в кэш образов на указанном узле.

Аргументы

Аргумент Description
--app-type-name [обязательный параметр] Имя манифеста приложения для соответствующего манифеста запрашиваемой службы.
--app-type-version [обязательный параметр] Версия манифеста приложения для соответствующего манифеста запрашиваемой службы.
--node-name [обязательный параметр] Имя узла.
--service-manifest-name [обязательный параметр] Имя манифеста службы, связанного со скачиваемыми пакетами.
--share-policy Список политик для управления доступом в формате JSON. Каждый элемент политики доступа состоит из имени и области действия. Имя соответствует имени кода, конфигурации или пакета данных, к которым предоставляется общий доступ. Область действия может иметь значение None, All, Code, Config или Data.
--timeout -t Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service package-health

Возвращает сведения о работоспособности пакета службы для указанного приложения, развернутого на узле Service Fabric.

Возвращает сведения о работоспособности пакета службы для указанного приложения, развернутого в узле Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию объектов HealthEvent, включенных в развернутый пакет службы, по состоянию работоспособности.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--service-package-name [обязательный параметр] Имя пакета службы.
--events-health-state-filter Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "OK" (2) и "Warning" (4).
-Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю.
-None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1.
-OK — фильтр, извлекающий входные данные с HealthState со значением "OK". Значение равно 2.
-Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4.
-Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8.
-All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65535.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service package-info

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

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

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--service-package-name [обязательный параметр] Имя пакета службы.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service package-list

Возвращает список пакетов службы, развернутых на узле Service Fabric.

Возвращает информацию о пакетах кода, развернутых на узле Service Fabric для указанного приложения.

Аргументы

Аргумент Description
--application-id [обязательный параметр] Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1".
--node-name [обязательный параметр] Имя узла.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service recover

Указывает кластеру Service Fabric, что следует попытаться восстановить указанную службу, которая находится в состоянии потери кворума.

Указывает кластеру Service Fabric, что следует попытаться восстановить указанную службу, которая находится в состоянии потери кворума. Эту операцию следует выполнять только в том случае, если известно, что неработающие реплики невозможно восстановить. Неправильное использование этого API может привести к потере данных.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service report-health

Отправляет отчет о работоспособности службы Service Fabric.

Возвращает состояние работоспособности указанной службы Service Fabric. Отчет должен содержать информацию об источнике отчета о работоспособности и свойстве, в котором об этом сообщается. Отчет отправляется в службу шлюза Service Fabric, которая передает его в хранилище данных о работоспособности. Отчет может быть принят шлюзом, но затем отклонен хранилищем данных о работоспособности после дополнительной проверки. Например, хранилище данных о работоспособности может отклонить отчет из-за недопустимого параметра, например устаревшего порядкового номера. Чтобы проверить, применен ли отчет в хранилище данных о работоспособности, найдите этот отчет в событиях работоспособности для службы.

Аргументы

Аргумент Description
--health-property [обязательный параметр] Свойство информации о работоспособности.

Один объект может возвращать отчеты о работоспособности для разных свойств. Это свойство имеет строковый формат, а не фиксированное перечисление, чтобы создатель отчетов мог гибко классифицировать состояние, активировавшее отчет. Например, создатель отчета с идентификатором источника LocalWatchdog может отслеживать состояние доступного дискового пространства на узле и передавать для этого узла свойство AvailableDisk. Этот же создатель отчета может отслеживать подключения узла и передавать свойство Connectivity для того же узла. В хранилище данных о работоспособности эти отчеты обрабатываются как независимые события работоспособности для указанного узла. Кроме идентификатора источника, свойство однозначно идентифицирует данные о работоспособности.
--health-state [обязательный параметр] Возможные значения: Invalid, OK, Warning, Error, Unknown.
--service-id [обязательный параметр] Идентификатор службы.

Обычно это полное имя службы из универсального кода ресурса (URI) без указания схемы "fabric:". Начиная с версии 6.0 иерархические имена разделяются знаком "~". Например, если имя службы — fabric:/myapp/app1/svc1, то в версии 6.0 и более поздних версиях идентификатором службы будет myapp~app1~svc1, а в предыдущих версиях идентификатором был бы myapp/app1/svc1.
--source-id [обязательный параметр] Имя источника, которое определяет клиента, службу наблюдения или компонент системы, создавший информацию о работоспособности.
--description Описание информации о работоспособности.

Это свойство предоставляет информацию об отчете в произвольном текстовом формате, доступном для чтения. Максимальная длина строки для описания составляет 4096 символов. Более длинные строки автоматически усекаются. При усечении в последние символы описания помещается маркер [Truncated], длина которого входит в строку длиной 4096 символов. Наличие маркера указывает на усечение. Обратите внимание, что усеченное описание включает менее 4096 символов исходной строки.
--immediate Этот флаг обозначает, что отчет нужно отправить немедленно.

Отчет о работоспособности отправляется в приложение шлюза Service Fabric, которое передает его в хранилище данных о работоспособности. Если флагу Immediate задано значение true, отчет немедленно отправляется через шлюз HTTP в хранилище данных о работоспособности, независимо от параметров клиента структуры, которые использует приложение шлюза HTTP. Это полезно для критически важных отчетов, которые необходимо передать как можно быстрее. В зависимости от времени и других условий отправка отчета может завершиться сбоем, например, если шлюз HTTP закрыт или сообщение не достигает этого шлюза. Если флагу Immediate задано значение false, отчет отправляется с учетом параметров клиента работоспособности через шлюз HTTP. Это значит, что он будет включен в пакет отчетов в соответствии со значением параметра HealthReportSendInterval. Рекомендуется применять именно такой вариант, так как он позволяет клиенту работоспособности оптимизировать отправку отчетов в хранилище данных о работоспособности, а также обработку отчетов о работоспособности. По умолчанию отчеты не отправляются немедленно.
--remove-when-expired Это значение указывает, удаляется ли отчет из хранилища работоспособности после истечения срока его действия.

Если задано значение true, отчет будет удален из хранилища работоспособности после истечения срока его действия. Если задано значение false, отчет с истекшим сроком действия рассматривается как указывающий на ошибку. Для этого свойства по умолчанию используется значение false. Если клиенты создают периодические отчеты, для параметра RemoveWhenExpired следует использовать значение false (по умолчанию). Если возникнет проблема с создателем отчетов (например, взаимоблокировка), не позволяющая ему отправить следующий отчет, это позволит зарегистрировать ошибку для сущности с истекшим отчетом о работоспособности. Такая сущность будет находиться в состоянии "Ошибка работоспособности".
--sequence-number Порядковый номер отчета о работоспособности в формате числовой строки.

Порядковый номер отчета используется хранилищем данных о работоспособности для отслеживания устаревших отчетов. Если значение не указано, порядковый номер автоматически создается клиентом работоспособности при добавлении отчета.
--timeout -t Значение по умолчанию: 60.
--ttl Срок, в течение которого отчет о работоспособности считается действительным. В этом поле указывается длительность в формате ISO8601.

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

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service resolve

Разрешает секцию Service Fabric.

Разрешает секцию службы Service Fabric для получения конечных точек реплик службы.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно он содержит полное имя службы из URI службы без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — "fabric:/myapp/app1/svc1", то в версии 6.0 и более поздних версиях идентификатором службы будет "myapp~app1~svc1", а в предыдущих версиях идентификатором был бы "myapp/app1/svc1".
--partition-key-type Тип ключа для секции. Этот параметр является обязательным, если для службы используется схема секционирования Int64Range или Named. Возможные значения приведены ниже. - None (1) — указывает, что параметр PartitionKeyValue не задан. Это допустимо для секций, использующих схему секционирования Singleton. Это значение по умолчанию. Значение равно 1. - Int64Range (2) — указывает, что параметр PartitionKeyValue содержит ключ секции в формате int64. Это допустимо для секций, использующих схему секционирования Int64Range. Значение равно 2. - Named (3) — указывает, что параметр PartitionKeyValue содержит имя секции. Это допустимо для секций, использующих схему секционирования Named. Значение равно 3.
--partition-key-value Ключ секции. Этот параметр является обязательным, если для службы используется схема секционирования Int64Range или Named. Это не идентификатор секции, а значение ключа целого числа или имя идентификатора секции. Например, если ваша служба использует секции диапазона от 0 до 10, то значение PartitionKeyValue будет целым числом в этом диапазоне. Выполните запрос описания службы, чтобы увидеть диапазон или имя.
--previous-rsp-version Значение в поле Version в полученном ранее ответе. Это значение является обязательным, если пользователь знает, что ранее полученный результат является устаревшим.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service type-list

Возвращает список, содержащий сведения о типах служб, поддерживаемых подготовленным типом приложения в кластере Service Fabric.

Возвращает список, содержащий сведения о типах служб, поддерживаемых подготовленным типом приложения в кластере Service Fabric. Указанный тип приложения должен существовать. В противном случае возвращается состояние 404.

Аргументы

Аргумент Description
--application-type-name [обязательный параметр] Имя типа приложения.
--application-type-version [обязательный параметр] Версия типа приложения.
--timeout -t Время ожидания сервера для выполнения операции (в секундах). Время ожидания — это интервал, в течение которого клиент готов ждать выполнения запрошенной операции. Значение этого параметра по умолчанию — 60 секунд. Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

sfctl service update

Обновляет указанную службу с помощью заданного описания обновления.

Аргументы

Аргумент Description
--service-id [обязательный параметр] Идентификатор службы. Обычно это полное имя службы из универсального кода ресурса (URI) без указания схемы "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя службы — fabric:/myapp/app1/svc1, то в версии 6.0 и более поздних версиях идентификатором службы будет myapp~app1~svc1, а в предыдущих версиях идентификатором был бы myapp/app1/svc1.
--constraints Ограничения размещения в виде строки. Ограничения размещения — это логические выражения, которые позволяют на основе свойств узла ограничить размещение службы определенными узлами в соответствии с требованиями этой службы. Например, чтобы разместить службу на узлах, у которых NodeType имеет значение blue, укажите "NodeColor == blue".
--correlated-service Имя целевой службы для сопоставления.
--correlation Сопоставление службы с существующей службой с помощью сходства расположения.
--instance-count Число экземпляров. Это значение относится к службам без отслеживания состояния.
--load-metrics Список метрик, используемых при балансировке нагрузки на узлах, в формате JSON.
--min-replica-set-size Минимальный размер набора реплик в виде числа. Это значение относится только к службам без отслеживания состояния.
--move-cost Указывает стоимость перемещения для службы. Возможные значения: Zero (Нулевая), Low (Низкая), Medium (Средняя), High (Высокая), VeryHigh (Очень высокая).
--placement-policy-list Список политик размещения для службы в формате JSON, а также связанные доменные имена. Может использоваться одна или несколько следующих политик: NonPartiallyPlaceService, PreferPrimaryDomain, RequireDomain, RequireDomainDistribution.
--quorum-loss-wait Максимальный интервал времени в секундах, в течение которого секция может находиться в состоянии потери кворума. Это значение относится только к службам без отслеживания состояния.
--replica-restart-wait Интервал времени в секундах, по истечении которого после выхода из строя реплики создается новая реплика. Это значение относится только к службам без отслеживания состояния.
--scaling-policies Список политик масштабирования для службы, указанный в формате JSON.
--service-placement-time Время, в течение которого реплики могут сохранять состояние InBuild, прежде чем будет отправлено оповещение о зависании сборки. Это значение относится только к службам без отслеживания состояния.
--stand-by-replica-keep Максимальный интервал времени в секундах, на протяжении которого сохраняются резервные реплики, прежде чем они будут удалены. Это значение относится только к службам без отслеживания состояния.
--stateful Указывает, что целевая служба отслеживает состояние.
--stateless Указывает, что целевая служба не отслеживает состояние.
--target-replica-set-size Размер целевого набора реплик в виде числа. Это значение относится только к службам без отслеживания состояния.
--timeout -t Значение по умолчанию: 60.

Глобальные аргументы

Аргумент Description
--debug Повышение уровня детализации журнала для включения всех журналов отладки.
--help -h Отображение этого справочного сообщения и выход.
--output -o Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json.
--query Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
--verbose Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Следующие шаги