共用方式為

sfctl 应用程序

创建、删除和管理应用程序和应用程序类型。

指令

命令 说明
创建 使用指定的说明创建服务Fabric应用程序。
删除 删除现有服务Fabric应用程序。
deployed 获取有关服务Fabric节点上部署的应用程序的信息。
deployed-health 获取有关部署在服务Fabric节点上的应用程序的运行状况的信息。
deployed-list 获取在服务Fabric节点上部署的应用程序的列表。
健康状况 获取 Service Fabric 应用程序的运行状况。
信息 获取有关服务Fabric应用程序的信息。
列表 获取与指定筛选器匹配的服务Fabric群集中创建的应用程序的列表。
加载 获取有关服务Fabric应用程序的加载信息。
清单 获取描述应用程序类型的清单。
规定 使用外部存储中的“.sfpkg”包或在映像存储中使用应用程序包预配或注册服务Fabric应用程序类型。
report-health 发送服务Fabric应用程序的运行状况报告。
类型 获取与指定名称完全匹配的服务Fabric群集中的应用程序类型列表。
type-list 获取服务Fabric群集中的应用程序类型列表。
取消预配 从群集中删除或取消注册服务Fabric应用程序类型。
升级 开始升级服务Fabric群集中的应用程序。
upgrade-resume 恢复升级服务Fabric群集中的应用程序。
upgrade-rollback 开始回滚服务Fabric群集中应用程序当前正在进行的升级。
upgrade-status 获取对此应用程序执行的最新升级的详细信息。
上传 将服务Fabric应用程序包复制到映像存储。

sfctl application create

使用指定的说明创建服务Fabric应用程序。

Arguments

论点 说明
--app-name [必需] 应用程序的名称，包括 'fabric：' URI 方案。
--app-type [必需] 应用程序清单中找到的应用程序类型名称。
--app-version [必需] 应用程序清单中定义的应用程序类型的版本。
--max-node-count 服务Fabric为此应用程序保留容量的最大节点数。 这并不意味着此应用程序的服务放置在所有这些节点上。
--指标 应用程序容量指标说明的 JSON 编码列表。 指标定义为名称，与应用程序所在的每个节点的一组容量相关联。
--min-node-count 服务Fabric为此应用程序保留容量的最小节点数。 这并不意味着此应用程序的服务将放置在所有这些节点上。
--参数 创建应用程序时要应用的应用程序参数替代的 JSON 编码列表。
--timeout -t 默认值：60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application delete

删除现有服务Fabric应用程序。

必须先创建应用程序，然后才能将其删除。 删除应用程序会删除属于该应用程序的所有服务。 默认情况下，服务Fabric尝试以正常方式关闭服务副本，然后删除该服务。 但是，如果服务在正常关闭副本时遇到问题，则删除操作可能需要很长时间或卡住。 使用可选的 ForceRemove 标志跳过正常关闭序列并强制删除应用程序及其所有服务。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 6.0 开始，分层名称以“~”字符分隔。 例如，如果应用程序名称为“fabric：/myapp/app1”，则应用程序标识为 6.0+ 中的“myapp~app1”，在以前的版本中为“myapp/app1”。
--force-remove 在不经过正常关闭序列的情况下，强制删除服务Fabric应用程序或服务。 此参数可用于强制删除因服务代码中阻止正常关闭副本的服务问题而删除删除的应用程序或服务。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值：60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

已部署 sfctl 应用程序

获取有关服务Fabric节点上部署的应用程序的信息。

如果提供的应用程序 ID 用于系统应用程序，则此查询将返回系统应用程序信息。 结果包括处于活动状态、激活状态和下载状态的已部署应用程序。 此查询要求节点名称对应于群集上的节点。 如果提供的节点名称未指向群集上任何活动服务Fabric节点，则查询将失败。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application deployed-health

获取有关部署在服务Fabric节点上的应用程序的运行状况的信息。

获取有关部署在服务Fabric节点上的应用程序的运行状况的信息。 使用 EventsHealthStateFilter 可以选择根据运行状况筛选已部署应用程序上报告的 HealthEvent 对象的集合。 使用 DeployedServicePackagesHealthStateFilter 可以选择根据运行状况筛选 DeployedServicePackageHealth 子级。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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） 的服务包的运行状况状态。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--events-health-state-filter 允许筛选基于运行状况返回的 HealthEvent 对象的集合。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的事件。 所有事件都用于评估聚合的运行状况状态。 如果未指定，则返回所有条目。 状态值是基于标志的枚举，因此该值可以是使用按位“OR”运算符获取的这些值的组合。 例如，如果提供的值为 6，则返回 HealthState 值为 OK （2） 和 Warning （4） 的所有事件。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--exclude-health-statistics 指示健康统计数据是否应作为查询结果的一部分返回。 默认情况下为 False。 统计数据显示健康状态为OK、警告和错误的儿童实体数量。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值：60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application deployed-list

获取在服务Fabric节点上部署的应用程序的列表。

获取在服务Fabric节点上部署的应用程序的列表。 除非按 ID 显式查询，否则结果不包括有关已部署的系统应用程序的信息。 结果包括处于活动状态、激活状态和下载状态的已部署应用程序。 此查询要求节点名称对应于群集上的节点。 如果提供的节点名称未指向群集上任何活动服务Fabric节点，则查询将失败。

Arguments

论点 说明
--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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl 应用程序运行状况

获取 Service Fabric 应用程序的运行状况。

返回 Service Fabric 应用程序的热度状态。 响应报告“确定”、“错误”或“警告”运行状况状态。 如果在运行状况存储中找不到实体，则返回错误。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 6.0 开始，分层名称以“~”字符分隔。 例如，如果应用程序名称为“fabric：/myapp/app1”，则应用程序标识为 6.0+ 中的“myapp~app1”，在以前的版本中为“myapp/app1”。
--deployed-applications-health-state-filter 允许根据应用健康状态过滤应用健康状态对象，这些对象在应用健康查询结果中返回。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的已部署应用程序。 所有已部署的应用程序都用于评估聚合运行状况。 如果未指定，则返回所有条目。 状态值是基于标志的枚举，因此该值可以是这些值的组合，使用按位“OR”运算符获取。 例如，如果提供的值为 6，则返回 HealthState 值为 OK （2） 和 Warning （4） 的已部署应用程序的运行状况状态。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--events-health-state-filter 允许筛选基于运行状况返回的 HealthEvent 对象的集合。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的事件。 所有事件都用于评估聚合的运行状况状态。 如果未指定，则返回所有条目。 状态值是基于标志的枚举，因此该值可以是使用按位“OR”运算符获取的这些值的组合。 例如，如果提供的值为 6，则返回 HealthState 值为 OK （2） 和 Warning （4） 的所有事件。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--exclude-health-statistics 指示健康统计数据是否应作为查询结果的一部分返回。 默认情况下为 False。 统计数据显示健康状态为OK、警告和错误的儿童实体数量。
--services-health-state-filter 允许根据服务健康查询结果中返回的服务健康状态对象进行过滤。 此参数的可能值包括以下运行状况状态之一的整数值。 仅返回与筛选器匹配的服务。 所有服务都用于评估聚合的运行状况状态。 如果未指定，则返回所有条目。 状态值是基于标志的枚举，因此该值可以是这些值的组合，使用按位“OR”运算符获取。 例如，如果提供的值为 6，则返回 HealthState 值为 OK （2） 和警告 （4） 的服务的运行状况状态。
- 默认值 - 默认值。 匹配任何 HealthState。 值为零。
- None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。
- 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。
- 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。
- 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。
- All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值：60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl 应用程序信息

获取有关服务Fabric应用程序的信息。

返回有关在服务Fabric群集中创建或正在创建的应用程序的信息，其名称与指定为参数的应用程序匹配。 响应包括有关应用程序的名称、类型、状态、参数和其他详细信息。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application list

获取与指定筛选器匹配的服务Fabric群集中创建的应用程序的列表。

获取有关在服务Fabric群集中创建或过程中创建的应用程序的信息，并匹配指定的筛选器。 响应包括有关应用程序的名称、类型、状态、参数和其他详细信息。 如果应用程序不适合页面，则会返回一页结果，并返回一个延续标记，该标记可用于获取下一页。 无法同时指定 Filter ApplicationTypeName 和 ApplicationDefinitionKindFilter。

Arguments

论点 说明
--application-definition-kind-filter 用于筛选 ApplicationDefinitionKind，这是用于定义服务Fabric应用程序的机制。
- 默认值，该值执行与选择“All”相同的函数。 值为 0。
- All - 与任何 ApplicationDefinitionKind 值的输入匹配的筛选器。 值为 65535。
- 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application load

获取有关服务Fabric应用程序的加载信息。

返回有关在服务Fabric群集中创建或正在创建的应用程序的加载信息，其名称与指定为参数的应用程序匹配。 响应包括名称、最小节点、最大节点数、应用程序当前占用的节点数以及应用程序负载指标信息。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application manifest

获取描述应用程序类型的清单。

响应包含应用程序清单 XML 作为字符串。

Arguments

论点 说明
--application-type-name [必需] 应用程序类型的名称。
--application-type-version [必需] 应用程序类型的版本。
--timeout -t 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值：60。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application provision

使用外部存储中的“.sfpkg”包或在映像存储中使用应用程序包预配或注册服务Fabric应用程序类型。

使用群集预配服务Fabric应用程序类型。 在实例化任何新应用程序之前，需要预配。 可以在 relativePathInImageStore 指定的应用程序包或使用外部'.sfpkg'的 URI 上执行预配操作。 除非设置了 --external-provision，否则此命令需要映像存储预配。

Arguments

论点 说明
--application-package-download-uri 从中可以使用 HTTP 或 HTTPS 协议下载应用程序包的“.sfpkg”应用程序包的路径。

仅适用于预配类型外部存储。 应用程序包可以存储在提供 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application report-health

发送服务Fabric应用程序的运行状况报告。

报告指定服务Fabric应用程序的运行状况状态。 报告必须包含有关其报告的运行状况报告源和属性的信息。 报告将发送到服务Fabric网关应用程序，该应用程序将转发到运行状况存储。 网关可能接受报告，但在进行额外验证后，运行状况存储会拒绝该报告。 例如，运行状况存储可能会因为参数无效而拒绝报告，例如过时的序列号。 若要查看报表是否在运行状况存储中应用，请获取应用程序运行状况并检查该报表是否显示。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。

这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 6.0 开始，分层名称以“~”字符分隔。 例如，如果应用程序名称为“fabric：/myapp/app1”，则应用程序标识为 6.0+ 中的“myapp~app1”，在以前的版本中为“myapp/app1”。
--health-property [必需] 运行状况信息的属性。

实体可以具有不同属性的运行状况报告。 该属性是一个字符串，而不是固定枚举，使记者能够灵活地对触发报表的状态条件进行分类。 例如，具有 SourceId“LocalWatchdog”的记者可以监视节点上可用磁盘的状态，以便它可以报告该节点上的“AvailableDisk”属性。 同一记者可以监视节点连接，因此它可以报告同一节点上的属性“Connectivity”。 在运行状况存储中，这些报告被视为指定节点的单独运行状况事件。 属性与 SourceId 一起唯一标识运行状况信息。
--health-state [必需] 可能的值包括：“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”。
--source-id [必需] 标识生成运行状况信息的客户端/监视器/系统组件的源名称。
--描述 运行状况信息的说明。

它表示用于添加有关报表的人工可读信息的自由文本。 说明的最大字符串长度为 4,096 个字符。 如果提供的字符串较长，则会自动截断该字符串。 截断时，说明的最后一个字符包含标记“[截断]”，总字符串大小为 4,096 个字符。 标记的存在表示用户发生了截断。 截断时，说明的原始字符串中少于 4,096 个字符。
--立即 指示是否应立即发送报表的标志。

运行状况报告将发送到服务Fabric网关应用程序，该应用程序将转发到运行状况存储。 如果“立即”设置为 true，则无论 HTTP 网关应用程序使用的构造客户端设置如何，报表都会立即从 HTTP 网关发送到运行状况存储。 这对于应尽快发送的关键报告非常有用。 根据计时和其他条件，发送报告可能仍然失败，例如，如果 HTTP 网关已关闭或消息未到达网关。 如果“即时”设置为 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl 应用程序类型

获取与指定名称完全匹配的服务Fabric群集中的应用程序类型列表。

返回有关在服务Fabric群集中预配的应用程序类型的信息。 这些结果由名称与指定为参数的应用程序类型完全匹配，并且符合给定的查询参数。 将返回与应用程序类型名称匹配的应用程序类型的所有版本，每个版本都作为一个应用程序类型返回。 响应包括有关应用程序类型的名称、版本、状态和其他详细信息。 这是一个分页查询，这意味着，如果并非所有应用程序类型都适合在页面中，则返回一页结果以及一个延续标记，可用于获取下一页。 例如，如果有 10 个应用程序类型，但页面只适合前三个应用程序类型，或者如果最大结果设置为 3，则返回 3 个。 若要访问其余结果，请使用下一个查询中返回的继续标记检索后续页面。 如果没有后续页面，则会返回空延续标记。

Arguments

论点 说明
--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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application type-list

获取服务Fabric群集中的应用程序类型列表。

返回有关在服务Fabric群集中预配的应用程序类型的信息。 应用程序类型的每个版本都作为一个应用程序类型返回。 响应包括有关应用程序类型的名称、版本、状态和其他详细信息。 这是一个分页查询，这意味着，如果并非所有应用程序类型都适合在页面中，则返回一页结果以及一个延续标记，可用于获取下一页。 例如，如果有 10 个应用程序类型，但页面只适合前三个应用程序类型，或者如果最大结果设置为 3，则返回 3 个。 若要访问其余结果，请使用下一个查询中返回的继续标记检索后续页面。 如果没有后续页面，则会返回空延续标记。

Arguments

论点 说明
--application-type-definition-kind-filter 用于筛选 ApplicationTypeDefinitionKind，这是用于定义服务Fabric应用程序类型的机制。
- 默认值，该值执行与选择“All”相同的函数。 值为 0。
- All - 与任何 ApplicationTypeDefinitionKind 值匹配输入的筛选器。 值为 65535。
- 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application unprovision

从群集中删除或取消注册服务Fabric应用程序类型。

仅当删除应用程序类型的所有应用程序实例时，才能执行此操作。 取消注册应用程序类型后，无法为此特定应用程序类型创建新的应用程序实例。

Arguments

论点 说明
--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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application upgrade

开始升级服务Fabric群集中的应用程序。

验证提供的应用程序升级参数，并在参数有效时开始升级应用程序。 升级说明将替换现有的应用程序说明。 这意味着如果未指定参数，则应用程序上的现有参数将被空参数列表覆盖。 这将导致应用程序使用应用程序清单中参数的默认值。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。

这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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 之间的数字。
--模式 用于在滚动升级期间监视运行状况的模式。 默认值：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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application upgrade-resume

恢复升级服务Fabric群集中的应用程序。

恢复不受监视的手动服务Fabric应用程序升级。 服务Fabric一次升级一个升级域。 对于不受监视的手动升级，服务Fabric完成升级域后，它会等待调用此 API，然后再继续下一个升级域。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application upgrade-rollback

开始回滚服务Fabric群集中应用程序当前正在进行的升级。

开始回滚当前应用程序升级到以前的版本。 此 API 只能用于回滚当前正在进行的升级，该升级将前滚到新版本。 如果应用程序当前未升级，请使用 StartApplicationUpgrade API 将其升级到所需版本，包括回滚到以前的版本。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application upgrade-status

获取对此应用程序执行的最新升级的详细信息。

返回有关最新应用程序升级状态的信息以及帮助调试应用程序运行状况问题的详细信息。

Arguments

论点 说明
--application-id [必需] 应用程序的标识。 这通常是没有“fabric：”URI 方案的应用程序的完整名称。 从版本 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。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

sfctl application upload

将服务Fabric应用程序包复制到映像存储。

（可选）显示包中每个文件的上传进度。 上载进度将发送到 stderr。

Arguments

论点 说明
--path [必需] 本地应用程序包的路径。
--压缩 仅适用于服务Fabric应用程序包。 将包含压缩的应用程序包的新文件夹创建到默认位置，或创建到由压缩位置参数指定的位置，然后上传新创建的文件夹。

如果已有 sfctl 生成的压缩文件，则会覆盖此标志。 如果目录不是应用程序包，则返回错误。 如果它已是压缩的应用程序包，则文件夹将按原样复制。 默认情况下，成功上传后，将删除新创建的压缩应用程序包。 如果上传未成功，请根据需要手动清理压缩包。 如果压缩位置参数引用不存在的目录，则删除不会删除创建的任何空 dirs。
--compressed-location 放置压缩的应用程序包的位置。

如果未提供任何位置，压缩包将放置在名为sfctl_compressed_temp的新创建文件夹下，该文件夹位于路径参数中指定的父目录下。 例如，如果路径参数具有值 C：/FolderA/AppPkg，则将压缩包添加到 C：/FolderA/sfctl_compressed_temp/AppPkg。
--imagestore-string 要将应用程序包上传到的目标映像存储区。 默认值：fabric：ImageStore。

若要上传到文件位置，请使用“file：”启动此参数。 否则，该值应为映像存储connection string，例如默认值。
--keep-compressed 是否在成功完成上传后保留生成的压缩包。

如果未设置，则成功完成后，将删除压缩的应用包。 如果上传未成功，则应用程序包将始终保留在输出目录中以重新加载。
--show-progress 显示大型包的文件上传进度。
--timeout -t 总超时（以秒为单位）。 上传将失败，并在上传超时持续时间过后返回错误。 此超时适用于整个应用程序包，单个文件超时等于剩余超时持续时间。 超时不包括压缩应用程序包所需的时间。 默认值：300。

全局参数

论点 说明
--debug 提高日志记录详细程度以显示所有调试日志。
--help -h 显示此帮助消息并退出。
--output -o 输出格式。 允许的值：json、jsonc、table、tsv。 默认值：json。
--查询 JMESPath 查询字符串。 有关详细信息和示例，请参阅 https://jmespath.org/。
--verbose 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

后续步骤

  • Setup Service Fabric CLI。
  • 了解如何使用 sample 脚本使用 Service Fabric CLI。
  • Last updated on