创建、删除和管理服务、服务类型和服务包。
指令
| 命令 | 说明 |
|---|---|
| app-name | 获取服务的服务Fabric应用程序的名称。 |
| code-package-list | 获取在服务Fabric节点上部署的代码包的列表。 |
| 创建 | 创建指定的服务Fabric服务。 |
| 删除 | 删除现有服务Fabric服务。 |
| deployed-type | 获取有关服务Fabric群集中节点上部署的应用程序的指定服务类型的信息。 |
| deployed-type-list | 获取包含有关服务Fabric群集中节点上部署的应用程序的服务类型的信息的列表。 |
| 说明 | 获取现有服务Fabric服务的说明。 |
| get-container-logs | 获取在服务Fabric节点上部署的容器的容器日志。 |
| 健康状况 | 获取指定服务Fabric服务的运行状况。 |
| 信息 | 获取有关属于 Service Fabric 应用程序的特定服务的信息。 |
| 列表 | 获取有关属于应用程序 ID 指定的应用程序的所有服务的信息。 |
| 清单 | 获取描述服务类型的清单。 |
| package-deploy | 将与指定服务清单关联的包下载到指定节点上的映像缓存。 |
| package-health | 获取为服务Fabric节点和应用程序部署的特定应用程序的服务包运行状况的相关信息。 |
| package-info | 获取与指定名称完全匹配的服务Fabric节点上部署的服务包列表。 |
| package-list | 获取在服务Fabric节点上部署的服务包的列表。 |
| recover | 向服务Fabric群集指示,它应尝试恢复当前停滞在仲裁丢失中的指定服务。 |
| report-health | 发送服务Fabric服务的运行状况报告。 |
| 解析 | 解析服务Fabric分区。 |
| type-list | 获取包含服务Fabric群集中预配的应用程序类型支持的服务类型的相关信息的列表。 |
| 更新 | 使用给定的更新说明更新指定的服务。 |
sfctl service app-name
获取服务的服务Fabric应用程序的名称。
获取指定服务的应用程序的名称。 如果服务 ID 不存在,则返回 404 FABRIC_E_SERVICE_DOES_NOT_EXIST 错误。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service code-package-list
获取在服务Fabric节点上部署的代码包的列表。
获取在给定应用程序的服务Fabric节点上部署的代码包列表。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 此标识通常是没有“fabric:”URI 方案的应用程序全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --node-name [必需] | 节点的名称。 |
| --code-package-name | 在服务清单中指定的代码包的名称,该包注册为 Service Fabric 群集中应用程序类型的一部分。 |
| --service-manifest-name | 服务Fabric群集中作为应用程序类型的一部分注册的服务清单的名称。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service create
创建指定的服务Fabric服务。
Arguments
| 论点 | 说明 |
|---|---|
| --app-id [必需] | 应用程序的标识。 此标识通常是没有“fabric:”URI 方案的应用程序全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --name [必需] | 服务的名称。 此名称应为应用程序 ID 的子级。 它是包含 URI 的 fabric\: 全名。 例如,服务 fabric\:/A/B 是应用程序的 fabric\:/A子级。 |
| --service-type [必需] | 服务类型的名称。 |
| --activation-mode | 服务包的激活模式。 |
| --约束 | 作为字符串的放置约束。 放置约束是节点属性上的布尔表达式,允许根据服务要求将服务限制为特定节点。 例如,若要在 NodeType 为 blue 的节点上放置服务,请指定以下内容:“NodeColor == blue”。 |
| --correlated-service | 要与之关联的目标服务的名称。 |
| --相关 | 使用对齐相关性将服务与现有服务相关联。 |
| --dns-name | 要创建的服务的 DNS 名称。 必须为此设置启用服务Fabric DNS 系统服务。 |
| --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、、PreferPrimaryDomainRequireDomainRequireDomainDistribution。 |
| --quorum-loss-wait | 允许分区处于仲裁丢失状态的最大持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --replica-restart-wait | 副本关闭和创建新副本之间的持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --scaling-policies | 此服务的缩放策略的 JSON 编码列表。 |
| --service-placement-time | 在报告生成停滞之前,副本可以保留 InBuild 的持续时间。 此参数仅适用于有状态服务。 |
| --singleton-scheme | 指示服务应具有单个分区或非分区服务。 |
| --stand-by-replica-keep | 在删除前保留 StandBy 副本的最大持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --状态 | 指示服务是有状态服务。 |
| --无 国籍 | 指示服务是无状态服务。 |
| --target-replica-set-size | 目标副本集大小为数字。 此参数仅适用于有状态服务。 |
| --timeout -t | 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service delete
删除现有服务Fabric服务。
必须先创建服务,然后才能将其删除。 默认情况下,服务Fabric尝试以正常方式关闭服务副本,然后删除该服务。 但是,如果服务在正常关闭副本时遇到问题,则删除操作可能需要很长时间或卡住。 使用可选的 ForceRemove 标志跳过正常关闭序列并强制删除服务。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --force-remove | 在不经过正常关闭序列的情况下,强制删除服务Fabric应用程序或服务。 此参数可用于强制删除应用程序或服务。 删除因服务代码中阻止正常关闭副本的问题而超时时,应使用它。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service deployed-type
获取有关服务Fabric群集中节点上部署的应用程序的指定服务类型的信息。
获取包含有关服务Fabric群集中节点上部署的应用程序的特定服务类型的信息的列表。 响应包括服务类型的名称、其注册状态、注册它的代码包以及服务包的激活 ID。 每个条目表示服务类型的一次激活,由激活 ID 区分。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 此标识通常是没有“fabric:”URI 方案的应用程序全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --node-name [必需] | 节点的名称。 |
| --service-type-name [必需] | 指定服务Fabric服务类型的名称。 |
| --service-manifest-name | 用于筛选已部署服务类型信息列表的服务清单的名称。 如果指定,响应仅包含有关此服务清单中定义的服务类型的信息。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service deployed-type-list
获取包含有关服务Fabric群集中节点上部署的应用程序的服务类型的信息的列表。
获取包含有关服务Fabric群集中节点上部署的应用程序的服务类型的信息的列表。 响应包括服务类型的名称、其注册状态、注册它的代码包以及服务包的激活 ID。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 此标识通常是没有“fabric:”URI 方案的应用程序全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --node-name [必需] | 节点的名称。 |
| --service-manifest-name | 用于筛选已部署服务类型信息列表的服务清单的名称。 如果指定,响应仅包含有关此服务清单中定义的服务类型的信息。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service description
获取现有服务Fabric服务的说明。
获取现有服务Fabric服务的说明。 必须先创建服务,然后才能获取服务的说明。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service get-container-logs
获取在服务Fabric节点上部署的容器的容器日志。
获取在给定代码包的服务Fabric节点上部署的容器的容器日志。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 此标识通常是没有“fabric:”URI 方案的应用程序全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --code-package-name [必需] | 在服务清单中指定的代码包的名称,该包注册为 Service Fabric 群集中应用程序类型的一部分。 |
| --node-name [必需] | 节点的名称。 |
| --service-manifest-name [必需] | 服务Fabric群集中作为应用程序类型的一部分注册的服务清单的名称。 |
| --以前 | 指定是否从代码包实例的退出/死容器中获取容器日志。 |
| --尾巴 | 要从日志末尾显示的行数。 默认值为 100。 “all”以显示完整的日志。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service health
获取指定服务Fabric服务的运行状况。
获取指定服务的运行状况信息。 使用 EventsHealthStateFilter 根据运行状况筛选服务报告的运行状况事件的集合。 使用 PartitionsHealthStateFilter 筛选返回的分区集合。 如果指定运行状况存储中不存在的服务,此请求将返回错误。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 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) 的所有事件。 - 默认值 - 默认值。 匹配任何 HealthState。 值为零。 - None - 与任何 HealthState 值不匹配的筛选器。 用于不返回给定状态集合的结果。 值为 1。 - 确定 - 与 HealthState 值 Ok 匹配输入的筛选器。 值为 2。 - 警告 - 与 HealthState 值 Warning 匹配输入的筛选器。 值为 4。 - 错误 - 与 HealthState 值 Error 匹配输入的筛选器。 值为 8。 - All - 与任何 HealthState 值的输入匹配的筛选器。 值为 65535。 |
| --exclude-health-statistics | 指示健康统计数据是否应作为查询结果的一部分返回。 默认情况下为 False。 统计数据显示健康状态为OK、警告和错误的儿童实体数量。 |
| --partitions-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。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service info
获取有关属于 Service Fabric 应用程序的特定服务的信息。
返回有关属于指定服务Fabric应用程序的指定服务的信息。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 这通常是没有“fabric:”URI 方案的应用程序的完整名称。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service list
获取有关属于应用程序 ID 指定的应用程序的所有服务的信息。
返回有关属于应用程序 ID 指定的应用程序的所有服务的信息。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 这通常是没有“fabric:”URI 方案的应用程序的完整名称。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --continuation-token | 延续标记参数用于获取下一组结果。 当系统的结果不适合单个响应时,API 响应中将包含具有无空值的延续令牌。 当此值传递给下一个 API 调用时,API 将返回下一组结果。 如果没有进一步的结果,则继续标记不包含值。 不应对此参数的值进行 URL 编码。 |
| --service-type-name | 用于筛选要查询的服务的服务类型名称。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service manifest
获取描述服务类型的清单。
获取描述服务类型的清单。 响应包含服务清单 XML 作为字符串。
Arguments
| 论点 | 说明 |
|---|---|
| --application-type-name [必需] | 应用程序类型的名称。 |
| --application-type-version [必需] | 应用程序类型的版本。 |
| --service-manifest-name [必需] | 服务Fabric群集中作为应用程序类型的一部分注册的服务清单的名称。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service package-deploy
将与指定服务清单关联的包下载到指定节点上的映像缓存。
Arguments
| 论点 | 说明 |
|---|---|
| --app-type-name [必需] | 相应请求的服务清单的应用程序清单的名称。 |
| --app-type-version [必需] | 相应请求的服务清单的应用程序清单的版本。 |
| --node-name [必需] | 节点的名称。 |
| --service-manifest-name [必需] | 与下载的包关联的服务清单的名称。 |
| --share-policy | 共享策略的 JSON 编码列表。 每个共享策略元素都由“name”和“scope”组成。 该名称对应于要共享的代码、配置或数据包的名称。 范围可以是“None”、“All”、“Code”、“Config”或“Data”。 |
| --timeout -t | 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service package-health
获取为服务Fabric节点和应用程序部署的特定应用程序的服务包运行状况的相关信息。
获取有关服务Fabric节点上部署的特定应用程序的服务包运行状况的信息。 使用 EventsHealthStateFilter 可以选择根据运行状况筛选针对已部署服务包报告的 HealthEvent 对象的集合。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 这通常是没有“fabric:”URI 方案的应用程序的完整名称。 从版本 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) 的所有事件。 - 默认值 - 默认值。 匹配任何 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 service package-info
获取与指定名称完全匹配的服务Fabric节点上部署的服务包列表。
返回有关在给定应用程序的服务Fabric节点上部署的服务包的信息。 这些结果由名称与指定为参数的服务包名称完全匹配的服务包。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 这通常是没有“fabric:”URI 方案的应用程序的完整名称。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --node-name [必需] | 节点的名称。 |
| --service-package-name [必需] | 服务包的名称。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service package-list
获取在服务Fabric节点上部署的服务包的列表。
返回有关在给定应用程序的服务Fabric节点上部署的服务包的信息。
Arguments
| 论点 | 说明 |
|---|---|
| --application-id [必需] | 应用程序的标识。 这通常是没有“fabric:”URI 方案的应用程序的完整名称。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果应用程序名称为“fabric:/myapp/app1”,则应用程序标识为 6.0+ 中的“myapp~app1”,在以前的版本中为“myapp/app1”。 |
| --node-name [必需] | 节点的名称。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service recover
向服务Fabric群集指示,它应尝试恢复当前停滞在仲裁丢失中的指定服务。
向服务Fabric群集指示,它应尝试恢复当前停滞在仲裁丢失中的指定服务。 仅当已知无法恢复关闭的副本时,才应执行此操作。 使用此 API 不正确可能会导致潜在的数据丢失。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service report-health
发送服务Fabric服务的运行状况报告。
报告指定服务Fabric服务的运行状况状态。 报告必须包含有关其报告的运行状况报告源和属性的信息。 报告将发送到服务Fabric网关服务,该服务将转发到运行状况存储。 网关可能接受报告,但在进行额外验证后,运行状况存储会拒绝该报告。 例如,运行状况存储可能会因为参数无效而拒绝报告,例如过时的序列号。 若要查看报表是否在运行状况存储中应用,请检查报告是否显示在服务的运行状况事件中。
Arguments
| 论点 | 说明 |
|---|---|
| --health-property [必需] | 运行状况信息的属性。 实体可以具有不同属性的运行状况报告。 该属性是一个字符串,而不是固定枚举,使记者能够灵活地对触发报表的状态条件进行分类。 例如,具有 SourceId“LocalWatchdog”的记者可以监视节点上可用磁盘的状态,以便它可以报告该节点上的“AvailableDisk”属性。 同一记者可以监视节点连接,因此它可以报告同一节点上的属性“Connectivity”。 在运行状况存储中,这些报告被视为指定节点的单独运行状况事件。 属性与 SourceId 一起唯一标识运行状况信息。 |
| --health-state [必需] | 可能的值包括:“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”。 |
| --service-id [必需] | 服务的标识。 这通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --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 service resolve
解析服务Fabric分区。
解析服务Fabric服务分区以获取服务副本的终结点。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --partition-key-type | 分区的键类型。 如果服务的分区方案为 Int64Range 或 Named,则此参数是必需的。 可能的值如下。 - 无 (1) - 指示未指定 PartitionKeyValue 参数。 这适用于分区方案为 Singleton 的分区。 这是默认值。 值为 1。 - Int64Range (2) - 指示 PartitionKeyValue 参数是 int64 分区键。 这适用于分区方案为 Int64Range 的分区。 值为 2。 - 命名 (3) - 指示 PartitionKeyValue 参数是分区的名称。 这适用于分区方案为 Named 的分区。 值为 3。 |
| --partition-key-value | 分区键。 如果服务的分区方案为 Int64Range 或 Named,则此参数是必需的。 它不是分区 ID,而是整数键值或分区 ID 的名称。 例如,如果服务使用从 0 到 10 的范围分区,则 PartitionKeyValue 将是该范围内的整数。 查询服务说明以查看范围或名称。 |
| --previous-rsp-version | 之前收到的响应的“版本”字段中的值。 如果用户知道之前获取的结果已过时,则此参数是必需的。 |
| --timeout -t | 执行作时服务器超时只需几秒。 该超时规定客户端愿意等待请求作完成的时间长度。 该参数的默认值为60秒。 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |
sfctl service type-list
获取包含服务Fabric群集中预配的应用程序类型支持的服务类型的相关信息的列表。
获取包含服务Fabric群集中预配的应用程序类型支持的服务类型的相关信息的列表。 提供的应用程序类型必须存在。 否则,将返回 404 状态。
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 service update
使用给定的更新说明更新指定的服务。
Arguments
| 论点 | 说明 |
|---|---|
| --service-id [必需] | 服务的标识。 此标识通常是不带“fabric:”URI 方案的服务的全名。 从版本 6.0 开始,分层名称以“~”字符分隔。 例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0+ 中的服务标识将为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。 |
| --约束 | 作为字符串的放置约束。 放置约束是节点属性上的布尔表达式,允许根据服务要求将服务限制为特定节点。 例如,若要在 NodeType 为蓝色的节点上放置服务,请指定以下内容:“NodeColor == blue”。 |
| --correlated-service | 要与之关联的目标服务的名称。 |
| --相关 | 使用对齐相关性将服务与现有服务相关联。 |
| --instance-count | 实例计数。 此参数仅适用于无状态服务。 |
| --load-metrics | 跨节点负载均衡时使用的指标的 JSON 编码列表。 |
| --min-replica-set-size | 最小副本集大小为数字。 此参数仅适用于有状态服务。 |
| --move-cost | 指定服务的移动成本。 可能的值为:“Zero”、“Low”、“Medium”、“High”、“VeryHigh”。 |
| --placement-policy-list | 服务的放置策略和任何关联的域名的 JSON 编码列表。 策略可以是一个或多个:NonPartiallyPlaceService、、PreferPrimaryDomainRequireDomainRequireDomainDistribution。 |
| --quorum-loss-wait | 允许分区处于仲裁丢失状态的最大持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --replica-restart-wait | 副本关闭和创建新副本之间的持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --scaling-policies | 此服务的缩放策略的 JSON 编码列表。 |
| --service-placement-time | 在报告生成停滞之前,副本可以保留 InBuild 的持续时间。 此参数仅适用于有状态服务。 |
| --stand-by-replica-keep | 在删除前保留 StandBy 副本的最大持续时间(以秒为单位)。 此参数仅适用于有状态服务。 |
| --状态 | 指示目标服务是有状态服务。 |
| --无 国籍 | 指示目标服务是无状态服务。 |
| --target-replica-set-size | 目标副本集大小为数字。 此参数仅适用于有状态服务。 |
| --timeout -t | 默认值:60。 |
全局参数
| 论点 | 说明 |
|---|---|
| --debug | 提高日志记录详细程度以显示所有调试日志。 |
| --help -h | 显示此帮助消息并退出。 |
| --output -o | 输出格式。 允许的值:json、jsonc、table、tsv。 默认值:json。 |
| --查询 | JMESPath 查询字符串。 有关详细信息和示例,请参阅 https://jmespath.org/。 |
| --verbose | 增加日志记录详细程度。 使用 --debug 获取完整的调试日志。 |