sfctl application
Создание и удаление приложений и типов приложений, а также управление ими.
Команды
| Команда | Описание |
|---|---|
| create | Создает приложение Service Fabric с помощью указанного описания. |
| удалить | Удаляет существующее приложение Service Fabric. |
| deployed | Возвращает сведения о приложении, развернутом на узле Service Fabric. |
| deployed-health | Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric. |
| deployed-list | Возвращает список приложений, развернутых на узле Service Fabric. |
| health | Возвращает сведения о работоспособности приложения Service Fabric. |
| сведения | Возвращает сведения о приложении Service Fabric. |
| list | Возвращает список приложений, созданных в кластере Service Fabric, которые соответствуют заданным фильтрам. |
| load | Возвращает сведения о нагрузке приложения Service Fabric. |
| manifest | Возвращает манифест, описывающий тип приложения. |
| provision | Подготавливает или регистрирует тип приложения Service Fabric в кластере с помощью пакета SFPKG во внешнем хранилище или пакета приложения в хранилище образов. |
| report-health | Отправляет отчет о работоспособности приложения Service Fabric. |
| тип | Возвращает список типов приложений в кластере Service Fabric, которые соответствуют точно указанному имени. |
| type-list | Возвращает список типов приложений в кластере Service Fabric. |
| unprovision | Удаляет тип приложения Service Fabric или отменяет его регистрацию в кластере. |
| обновление | Запускает обновление приложения в кластере Service Fabric. |
| upgrade-resume | Возобновляет обновление приложения в кластере Service Fabric. |
| upgrade-rollback | Запускает откат текущего обновления приложения в кластере Service Fabric. |
| upgrade-status | Получает сведения о последнем обновлении этого приложения. |
| upload | Копирует пакет приложения Service Fabric в хранилище образов. |
sfctl application create
Создает приложение Service Fabric с помощью указанного описания.
Аргументы
| Аргумент | Описание |
|---|---|
| --app-name [обязательный параметр] | Имя приложения, включая схему универсального кода ресурса (URI) "fabric:". |
| --app-type [обязательный параметр] | Имя типа приложения, обнаруженное в манифесте приложения. |
| --app-version [обязательный параметр] | Версия типа приложения, определенная в манифесте приложения. |
| --max-node-count | Максимальное количество узлов, емкость которых Service Fabric резервирует для этого приложения. Обратите внимание: это не означает, что службы данного приложения размещаются на всех этих узлах. |
| --metrics | Список описаний метрик емкости приложения в формате JSON. Метрика определяется как имя, связанное с набором емкостей для каждого узла, на котором существует данное приложение. |
| --min-node-count | Минимальное количество узлов, емкость которых Service Fabric резервирует для этого приложения. Обратите внимание: это не означает, что службы данного приложения размещаются на всех этих узлах. |
| --parameters | Список переопределяемых параметров приложения в формате JSON, применяемых при создании приложения. |
| --timeout -t | Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application delete
Удаляет существующее приложение Service Fabric.
Приложение должно быть создано, прежде чем его можно будет удалить. При удалении приложения удаляются все службы, которые входят в состав этого приложения. По умолчанию Service Fabric попытается нормально закрыть реплики службы, а затем удалит службу. Однако если из-за проблем в работе службы нормально закрыть реплики не удалось, операция удаления может длиться много времени или оказаться заблокированной. Используйте необязательный флаг ForceRemove, чтобы пропустить последовательность нормального закрытия и принудительно удалить приложение и все его службы.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --force-remove | Принудительное удаление приложения или службы Service Fabric без выполнения последовательности нормального завершения работы. Этот параметр можно использовать, чтобы принудительно удалить приложение или службу, срок удаления которой истек из-за проблем в коде службы, которые мешают нормальному закрытию реплик. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application deployed
Возвращает сведения о приложении, развернутом на узле Service Fabric.
Если предоставленный идентификатор приложения предназначен для системного приложения, то этот запрос возвращает сведения о системном приложении. Результаты охватывают развернутые приложения в активном состоянии, состоянии активации и загрузки. Для этого запроса необходимо, чтобы имя узла соответствовало имени узла в кластере. Если имя указанного узла не указывает на любой из активных узлов Service Fabric в кластере, запрос завершается ошибкой.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --node-name [обязательный параметр] | Имя узла. |
| --include-health-state | Добавление состояния работоспособности сущности. Если этот параметр имеет значение false или не указан, возвращается состояние работоспособности Unknown. Если для этого параметра задано значение true, параллельно выполняется запрос к узлу и службе системы работоспособности, после чего результаты объединяются. В результате запрос требует больше ресурсов и времени. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application deployed-health
Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric.
Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию объектов HealthEvent, включенных в развернутое приложение, по состоянию работоспособности. Используйте DeployedServicePackagesHealthStateFilter, чтобы отфильтровать дочерние элементы DeployedServicePackageHealth по состоянию работоспособности.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --node-name [обязательный параметр] | Имя узла. |
| --deployed-service-packages-health-state-filter | Позволяет фильтровать объекты состояния работоспособности развернутых пакетов службы, возвращаемые в результате запроса работоспособности приложения, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те развернутые пакеты службы, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности развернутого приложения используются все развернутые пакеты службы. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращается состояние работоспособности пакетов службы со значениями HealthState "OK" (2) и "Warning" (4). -Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю. -None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1. -ОК — фильтр, извлекающий входные данные с HealthState со значением "Ок". Значение равно 2. -Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4. -Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8. -All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65 535. |
| --events-health-state-filter | Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "ОК" (2) и "Warning" (4). -Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю. -None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1. -ОК — фильтр, извлекающий входные данные с HealthState со значением "Ок". Значение равно 2. -Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4. -Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8. -All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65 535. |
| --exclude-health-statistics | Указывает, должна ли возвращаться статистика работоспособности в составе результатов запроса. Значение по умолчанию: false. Статистика содержит число дочерних сущностей в состоянии работоспособности OK, Warning и Error. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application deployed-list
Возвращает список приложений, развернутых на узле Service Fabric.
Возвращает список приложений, развернутых на узле Service Fabric. Результаты не включают в себя сведения о развернутых системных приложениях, если только они не запрашиваются явным образом по идентификатору. Результаты охватывают развернутые приложения в активном состоянии, состоянии активации и загрузки. Для этого запроса необходимо, чтобы имя узла соответствовало имени узла в кластере. Если имя указанного узла не указывает на любой из активных узлов Service Fabric в кластере, запрос завершается ошибкой.
Аргументы
| Аргумент | Описание |
|---|---|
| --node-name [обязательный параметр] | Имя узла. |
| --continuation-token | Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса. |
| --include-health-state | Добавление состояния работоспособности сущности. Если этот параметр имеет значение false или не указан, возвращается состояние работоспособности Unknown. Если для этого параметра задано значение true, параллельно выполняется запрос к узлу и службе системы работоспособности, после чего результаты объединяются. В результате запрос требует больше ресурсов и времени. |
| --max-results | Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application health
Возвращает сведения о работоспособности приложения Service Fabric.
Возвращает состояние работоспособности приложения Service Fabric. Ответ содержит значение состояния работоспособности "Ok" (приложение работоспособно), "Error" (произошла ошибка) или "Warning" (Предупреждение). Если сущность не найдена в хранилище данных о работоспособности, возвращается значение Error.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --deployed-applications-health-state-filter | Позволяет фильтровать объекты состояния работоспособности развернутых приложений, возвращаемые в результате запроса работоспособности приложения, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Будут возвращены только объекты развернутых приложений, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все развернутые приложения. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращается состояние работоспособности развернутых приложений со значениями HealthState "OK" (2) и "Warning" (4). -Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю. -None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1. -ОК — фильтр, извлекающий входные данные с HealthState со значением "Ок". Значение равно 2. -Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4. -Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8. -All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65 535. |
| --events-health-state-filter | Позволяет отфильтровать коллекцию возвращаемых объектов HealthEvent по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те события, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все события. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращаются все события со значениями HealthState "ОК" (2) и "Warning" (4). -Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю. -None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1. -ОК — фильтр, извлекающий входные данные с HealthState со значением "Ок". Значение равно 2. -Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4. -Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8. -All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65 535. |
| --exclude-health-statistics | Указывает, должна ли возвращаться статистика работоспособности в составе результатов запроса. Значение по умолчанию: false. Статистика содержит число дочерних сущностей в состоянии работоспособности OK, Warning и Error. |
| --services-health-state-filter | Позволяет фильтровать объекты состояния работоспособности служб, возвращаемые в результате запроса работоспособности службы, по состоянию работоспособности. Возможные значения для этого параметра — целочисленное значение одного из приведенных ниже состояний работоспособности. Возвращаются только те службы, которые соответствуют заданному фильтру. Для оценки общего состояния работоспособности используются все службы. Если фильтр не указан, возвращаются все записи. Значения состояния — это перечисление на основе флага, поэтому значение может представлять собой сочетание этих значений, полученное с помощью битового оператора OR. Например, если указано значение 6, то возвращается состояние работоспособности служб со значениями HealthState "OK" (2) и "Warning" (4). -Default — значение по умолчанию. Соответствует любому значению HealthState. Значение равно нулю. -None — фильтр, который не соответствует какому-либо значению HealthState. Используется для возвращения нуля результатов для определенной коллекции состояний. Значение равно 1. -ОК — фильтр, извлекающий входные данные с HealthState со значением "Ок". Значение равно 2. -Warning — фильтр, извлекающий входные данные с HealthState со значением "Warning". Значение равно 4. -Error — фильтр, извлекающий входные данные с HealthState со значением "Error". Значение равно 8. -All — фильтр, извлекающий входные данные с любым значением HealthState. Значение равно 65 535. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application info
Возвращает сведения о приложении Service Fabric.
Возвращает сведения о приложении, которое создано или находится в процессе создания в кластере Service Fabric и имя которого совпадает со значением, указанным в качестве параметра. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --exclude-application-parameters | Флаг, указывающий, исключаются ли из результата параметры приложения. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application list
Возвращает список приложений, созданных в кластере Service Fabric, которые соответствуют заданным фильтрам.
Возвращает сведения о приложении, которое создано или находится в процессе создания в кластере Service Fabric и которое соответствует указанным фильтрам. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении. Если сведения о приложении не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Фильтры ApplicationTypeName и ApplicationDefinitionKindFilter не могут быть заданы одновременно.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-definition-kind-filter | Используется для фильтрации по ApplicationDefinitionKind. Это механизм, необходимый для определения приложения Service Fabric. Default — значение по умолчанию, которое выполняет ту же функцию, что и значение "All". Значение равно 0. -All — фильтр, извлекающий входные данные с любым значением ApplicationDefinitionKind. Значение равно 65 535. - ServiceFabricApplicationDescription — фильтр, извлекающий входные данные со значением ApplicationDefinitionKind, равным ServiceFabricApplicationDescription. Значение равно 1. - Compose — фильтр, извлекающий входные данные со значением ApplicationDefinitionKind, равным Compose. Значение равно 2. |
| --application-type-name | Имя типа приложения, используемое для фильтрации запрашиваемых приложений. Это значение не должно содержать версию типа приложения. |
| --continuation-token | Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса. |
| --exclude-application-parameters | Флаг, указывающий, исключаются ли из результата параметры приложения. |
| --max-results | Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application load
Возвращает сведения о нагрузке приложения Service Fabric.
Возвращает сведения о нагрузке приложения, которое создано или находится в процессе создания в кластере Service Fabric и имя которого совпадает со значением, указанным в качестве параметра. В ответе содержится имя, минимальное и максимальное число узлов, количество узлов, которые в настоящее время использует приложение, и информация о метриках нагрузки приложения.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application manifest
Возвращает манифест, описывающий тип приложения.
Ответ содержит XML манифеста приложения в виде строки.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-type-name [обязательный параметр] | Имя типа приложения. |
| --application-type-version [обязательный параметр] | Версия типа приложения. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application provision
Подготавливает или регистрирует тип приложения Service Fabric в кластере с помощью пакета SFPKG во внешнем хранилище или пакета приложения в хранилище образов.
Подготавливает тип приложения Service Fabric в кластере. Подготовку необходимо выполнить перед созданием любого нового приложения. Операция подготовки может выполняться либо с помощью пакета приложения, указанного в параметре relativePathInImageStore, либо с использованием URI внешнего SFPKG-файла. Если значение --external-provision не задано, то эта команда ожидает подготовки хранилища образов.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-package-download-uri | Путь к пакету приложения SFPKG, по которому можно скачать пакет приложения с помощью протоколов HTTP или HTTPS. Необходим только для подготовки внешнего хранилища. Пакет приложения может быть сохранен во внешнем хранилище. В этом случае можно скачать файл с помощью операции GET. Поддерживаются протоколы HTTP и HTTPS, и для пути должен быть разрешен доступ на чтение. |
| --application-type-build-path | Необходим только для подготовки в хранилище образов. Относительный путь для пакета приложения в хранилище образов указывается во время операции, предшествующей передаче. |
| --application-type-name | Необходим только для подготовки внешнего хранилища. Имя типа приложения соответствует имени, обнаруженном в манифесте приложения. |
| --application-type-version | Необходим только для подготовки внешнего хранилища. Версия типа приложения соответствует версии, обнаруженной в манифесте приложения. |
| --external-provision | Расположение, из которого пакет приложения может быть подготовлен или зарегистрирован. Указывает, что выполняется подготовка для пакета приложения, который ранее был передан во внешнее хранилище. Имя пакета приложения заканчивается расширением SFPKG. |
| --no-wait | Указывает, должна ли подготовка выполняться асинхронно. Если задано значение true, после принятия запроса системой операция подготовки продолжается без какого-либо ограничения времени ожидания. Значением по умолчанию является false. Для больших пакетов приложений рекомендуется установить значение true. |
| --timeout -t | Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application report-health
Отправляет отчет о работоспособности приложения Service Fabric.
Возвращает состояние работоспособности для указанного приложения Service Fabric. Отчет должен содержать информацию об источнике отчета о работоспособности и свойстве, в котором об этом сообщается. Отчет отправляется в приложение шлюза Service Fabric, которое передает его в хранилище данных о работоспособности. Отчет может быть принят шлюзом, но затем отклонен хранилищем данных о работоспособности после дополнительной проверки. Например, хранилище данных о работоспособности может отклонить отчет из-за недопустимого параметра, например устаревшего порядкового номера. Чтобы проверить, применен ли отчет в хранилище данных о работоспособности, получите данные о работоспособности приложения и проверьте, появился ли этот отчет.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0 иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --health-property [обязательный параметр] | Свойство информации о работоспособности. Один объект может возвращать отчеты о работоспособности для разных свойств. Это свойство имеет строковый формат, а не фиксированное перечисление, чтобы создатель отчетов мог гибко классифицировать состояние, активировавшее отчет. Например, создатель отчета с идентификатором источника LocalWatchdog может отслеживать состояние доступного дискового пространства на узле и передавать для этого узла свойство AvailableDisk. Этот же создатель отчета может отслеживать подключения узла и передавать свойство Connectivity для того же узла. В хранилище данных о работоспособности эти отчеты обрабатываются как независимые события работоспособности для указанного узла. Кроме идентификатора источника, свойство однозначно идентифицирует данные о работоспособности. |
| --health-state [обязательный параметр] | Возможные значения: Invalid, OK, Warning, Error, Unknown. |
| --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). Если значение не указано, по умолчанию устанавливается бесконечный срок жизни. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application type
Возвращает список типов приложений в кластере Service Fabric, которые соответствуют точно указанному имени.
Возвращает сведения о типах приложений, которые подготовлены или подготавливаются в кластере Service Fabric. Эти результаты содержат типы приложений, имена которых совпадают со значением, указанным в качестве параметра, и которые соответствуют заданным параметрам запроса. Возвращаются все версии типа приложения, соответствующего заданному имени типа приложения, при этом каждая версия возвращаются как тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это страничный запрос. Это значит, что если сведения о типах приложений не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Например, если существуют 10 типов приложения, но страница вмещает только первые 3 типа, или задано максимальное число результатов, равное 3, тогда возвращаются 3 типа. Чтобы просмотреть остальную часть результатов, можно получить следующие страницы с помощью маркера продолжения, передав его в следующем запросе. Если следующие страницы отсутствуют, возвращается пустой маркер продолжения.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-type-name [обязательный параметр] | Имя типа приложения. |
| --application-type-version | Версия типа приложения. |
| --continuation-token | Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса. |
| --exclude-application-parameters | Флаг, указывающий, исключаются ли из результата параметры приложения. |
| --max-results | Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application type-list
Возвращает список типов приложений в кластере Service Fabric.
Возвращает сведения о типах приложений, которые подготовлены или подготавливаются в кластере Service Fabric. Каждая версия типа приложения возвращается как один тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это страничный запрос. Это значит, что если сведения о типах приложений не помещаются на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы. Например, если существуют 10 типов приложения, но страница вмещает только первые 3 типа, или задано максимальное число результатов, равное 3, тогда возвращаются 3 типа. Чтобы просмотреть остальную часть результатов, можно получить следующие страницы с помощью маркера продолжения, передав его в следующем запросе. Если следующие страницы отсутствуют, возвращается пустой маркер продолжения.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-type-definition-kind-filter | Используется для фильтрации по ApplicationTypeDefinitionKind. Это механизм, необходимый для определения типа приложения Service Fabric. Default — значение по умолчанию, которое выполняет ту же функцию, что и значение "All". Значение равно 0. -All — фильтр, извлекающий входные данные с любым значением ApplicationTypeDefinitionKind. Значение равно 65 535. -ServiceFabricApplicationPackage — фильтр, извлекающий входные данные со значением ApplicationTypeDefinitionKind, равным ServiceFabricApplicationPackage. Значение равно 1. -Compose — фильтр, извлекающий входные данные со значением ApplicationTypeDefinitionKind, равным Compose. Значение равно 2. |
| --continuation-token | Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса. |
| --exclude-application-parameters | Флаг, указывающий, исключаются ли из результата параметры приложения. |
| --max-results | Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application unprovision
Удаляет тип приложения Service Fabric или отменяет его регистрацию в кластере.
Эта операция может быть выполнена только в том случае, если были удалены все экземпляры приложения указанного типа. После отмены регистрации типа приложения создание экземпляров приложения этого типа невозможно.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-type-name [обязательный параметр] | Имя типа приложения. |
| --application-type-version [обязательный параметр] | Версия типа приложения, определенная в манифесте приложения. |
| --async-parameter | Параметр, указывающий, должна ли отмена подготовки происходить асинхронно. Если задано значение true, после принятия запроса системой операция отмены подготовки продолжается без какого-либо ограничения времени ожидания. Значением по умолчанию является false. Тем не менее для больших пакетов приложений, которые были подготовлены, рекомендуется установить значение true. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application upgrade
Запускает обновление приложения в кластере Service Fabric.
Проверяет указанные параметры обновления приложения и запускает обновление приложения, если параметры являются допустимыми. Обратите внимание на то, что описание обновления заменяет существующее описание приложения. Это означает, что если параметры не указаны, то существующие параметры приложений будут перезаписаны пустым списком параметров. Это приведет к тому, что приложение будет использовать значения параметров по умолчанию из манифеста приложения.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --application-version [обязательный параметр] | Версия типа целевого приложения (обнаруженная в манифесте) для обновления. |
| --parameters [обязательный параметр] | Список переопределяемых параметров приложения в формате JSON, применяемых при обновлении приложения. |
| --default-service-health-policy | Спецификация политики работоспособности в формате JSON, используемой по умолчанию для оценки работоспособности типа службы. |
| --failure-action | Действие, выполняемое, когда служба отслеживаемого обновления обнаруживает нарушения политики мониторинга или политики работоспособности. |
| --force-restart | Принудительный перезапуск процессов при обновлении, даже если версии кода не были изменены. |
| --health-check-retry-timeout | Продолжительность времени между попытками выполнить проверку работоспособности, если приложение или кластер неработоспособны. По умолчанию: PT0H10M0S. |
| --health-check-stable-duration | Период времени, в течение которого приложение или кластер должен оставаться работоспособным, прежде чем процесс обновления перейдет к следующему домену обновления. По умолчанию: PT0H2M0S. Сначала он интерпретируется как строка, представляющая длительность ISO 8601. В случае неудачи он интерпретируется как число, представляющее общее количество миллисекунд. |
| --health-check-wait-duration | Продолжительность ожидания после завершения обновления домена до начала процесса проверки работоспособности. По умолчанию: 0. |
| --max-unhealthy-apps | Максимальный допустимый процент неработоспособных развернутых приложений. Представленный в виде числа от 0 до 100. |
| --mode | Режим, используемый для отслеживания работоспособности во время последовательного обновления. Значение по умолчанию: "UnmonitoredAuto". |
| --replica-set-check-timeout | Максимальный период времени, на протяжении которого можно блокировать обработку домена обновления и не допустить потери доступности в случае возникновения непредвиденных проблем. Измеряется в секундах. |
| --service-health-policy | Сопоставление политик работоспособности для типов служб и типов служб в формате JSON. Сопоставление является пустым по умолчанию. |
| --timeout -t | Значение по умолчанию: 60. |
| --upgrade-domain-timeout | Время выполнения каждого домена обновления, по истечении которого выполняется действие FailureAction. Значение по умолчанию: P10675199DT02H48M05.4775807S. Сначала он интерпретируется как строка, представляющая длительность ISO 8601. В случае неудачи он интерпретируется как число, представляющее общее количество миллисекунд. |
| --upgrade-timeout | Общее время завершения обновления, по истечении которого выполняется действие FailureAction. Значение по умолчанию: P10675199DT02H48M05.4775807S. Сначала он интерпретируется как строка, представляющая длительность ISO 8601. В случае неудачи он интерпретируется как число, представляющее общее количество миллисекунд. |
| --warning-as-error | Указывает, учитываются ли предупреждения с той же степенью серьезности, что и ошибки. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application upgrade-resume
Возобновляет обновление приложения в кластере Service Fabric.
Возобновление неотслеживаемого ручного обновления приложения Service Fabric. Service Fabric обновляет домены обновления по одному. При неотслеживаемом обновлении вручную по завершении обновления домена обновления Service Fabric ожидает вызов этого API, прежде чем переходить к следующему домену обновления.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --upgrade-domain-name [обязательный параметр] | Имя домена обновления, на котором будет возобновлено обновление. |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application upgrade-rollback
Запускает откат текущего обновления приложения в кластере Service Fabric.
Запускает откат текущего обновления приложения до предыдущей версии. Этот API можно использовать только для отката текущего активного обновления, при котором выполняется накат до новой версии. Если обновление приложения в текущий момент не выполняется, используйте API StartApplicationUpgrade, чтобы обновить его до нужной версии, включая откат до предыдущей версии.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application upgrade-status
Получает сведения о последнем обновлении этого приложения.
Возвращает сведения о состоянии последнего обновления приложения, а также сведения для упрощения отладки проблем в работоспособности приложения.
Аргументы
| Аргумент | Описание |
|---|---|
| --application-id [обязательный параметр] | Идентификатор приложения. Обычно это полное имя приложения без схемы универсального кода ресурса (URI) "fabric:". Начиная с версии 6.0, иерархические имена разделяются знаком "~". Например, если имя приложения — "fabric:/myapp/app1", то в версии 6.0 и более поздних версиях идентификатором приложения будет "myapp~app1", а в предыдущих версиях идентификатором был бы "myapp/app1". |
| --timeout -t | Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд. Значение по умолчанию: 60. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
sfctl application upload
Копирует пакет приложения Service Fabric в хранилище образов.
При необходимости можно отобразить ход передачи каждого файла в пакете. Данные о ходе передачи отправляются в stderr.
Аргументы
| Аргумент | Описание |
|---|---|
| --path [обязательный параметр] | Путь к локальному пакету приложения. |
| --compress | Применяется только к пакетам приложения Service Fabric. Создает новую папку со сжатым пакетом приложения в расположении по умолчанию или в расположении, указанном в параметре расположения сжатого пакета, затем отправляет созданную папку. Если sfctl уже создал сжатый файл, то он будет перезаписан, если установлен этот флаг. Если каталог не является пакетом приложения, то возвращается ошибка. Если папка уже является сжатым пакетом приложения, то папка будет скопирована как есть. По умолчанию вновь созданный сжатый пакет приложения будет удален после успешно выполненной отправки. Если отправка не была выполнена успешно, в случае необходимости, выполните очистку сжатого пакета вручную. Удаление не приведет к удалению пустых каталогов, которые могли быть созданы, если в параметре расположения сжатого пакета были ссылки на несуществующие каталоги. |
| --compressed-location | Расположение для размещения сжатого пакета приложения. Если расположение не указано, то сжатый пакет будет помещен во вновь созданную папку с именем sfctl_compressed_temp в родительском каталоге, указанном в аргументе пути. Например, если аргумент пути задан как C:/FolderA/AppPkg, то сжатый пакет будет добавлен в C:/FolderA/sfctl_compressed_temp/AppPkg. |
| --imagestore-string | Целевое хранилище образов для передачи пакета приложения. По умолчанию: fabric:ImageStore. Для отправки в расположение файла в начале этого параметра укажите "file". В противном случае значение должно являться строкой подключения к хранилищу образа, например как в значении по умолчанию. |
| --keep-compressed | Указывает, следует ли сохранить созданный сжатый пакета после успешного выполнения отправки. Если параметр не указан, то после успешного выполнения отправки сжатые пакеты будут удалены. Если отправка не была выполнена, то пакет приложения будет оставаться в выходном каталоге для повторной отправки. |
| --show-progress | Отображение хода передачи файлов для больших пакетов. |
| --timeout -t | Общее время ожидания в секундах. После истечения времени ожидания отправка даст сбой и вернет ошибку. Это время ожидания применяется ко всему пакету приложения, время ожидания для отдельных файлов равно значению оставшегося времени ожидания. В промежуток ожидания не входит время, необходимое для сжатия пакета приложения. По умолчанию: 300. |
Глобальные аргументы
| Аргумент | Описание |
|---|---|
| --debug | Повышение уровня детализации журнала для включения всех журналов отладки. |
| --help -h | Отображение этого справочного сообщения и выход. |
| --output -o | Формат вывода. Допустимые значения: json, jsonc, table, tsv. Значение по умолчанию: json. |
| --query | Строка запроса JMESPath. Дополнительные сведения и примеры см. на сайте http://jmespath.org/. |
| --verbose | Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug. |
Дальнейшие действия
- Настройте интерфейс командной строки Service Fabric.
- Узнайте, как использовать интерфейс командной строки Service Fabric, с помощью примеров сценариев.