sfctl replicasfctl replica

管理属于服务分区的副本。Manage the replicas that belong to service partitions.

命令Commands

命令Command 说明Description
deployeddeployed 获取部署在 Service Fabric 节点上的副本的详细信息。Gets the details of replica deployed on a Service Fabric node.
deployed-listdeployed-list 获取部署在 Service Fabric 节点上的副本的列表。Gets the list of replicas deployed on a Service Fabric node.
healthhealth 获取 Service Fabric 有状态服务副本或无状态服务实例的运行状况。Gets the health of a Service Fabric stateful service replica or stateless service instance.
infoinfo 获取有关 Service Fabric 分区的副本的信息。Gets the information about a replica of a Service Fabric partition.
listlist 获取有关 Service Fabric 服务分区的副本的信息。Gets the information about replicas of a Service Fabric service partition.
removeremove 删除节点上运行的服务副本。Removes a service replica running on a node.
report-healthreport-health 发送有关 Service Fabric 副本的运行状况报告。Sends a health report on the Service Fabric replica.
restartrestart 重启节点上运行的持久性服务的服务副本。Restarts a service replica of a persisted service running on a node.

sfctl replica deployedsfctl replica deployed

获取部署在 Service Fabric 节点上的副本的详细信息。Gets the details of replica deployed on a Service Fabric node.

获取部署在 Service Fabric 节点上的副本的详细信息。Gets the details of the replica deployed on a Service Fabric node. 信息包括服务类型、服务名称、当前服务操作、当前服务操作开始日期时间、分区 ID、副本/实例 ID、报告的负载和其他信息。The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.

参数Arguments

参数Argument 说明Description
--node-name [必需]--node-name [Required] 节点的名称。The name of the node.
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 副本的标识符。The identifier of the replica.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica deployed-listsfctl replica deployed-list

获取部署在 Service Fabric 节点上的副本的列表。Gets the list of replicas deployed on a Service Fabric node.

获取一个列表,其中包含有关 Service Fabric 节点上部署的副本的信息。Gets the list containing the information about replicas deployed on a Service Fabric node. 这些信息包括分区 ID、副本 ID、副本状态、服务名称、服务类型名称和其他信息。The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. 使用 PartitionId 或 ServiceManifestName 查询参数可返回有关与这些参数的指定值匹配的已部署副本的信息。Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.

参数Arguments

参数Argument 说明Description
--application-id [必需]--application-id [Required] 应用程序的标识。The identity of the application. 这通常是不带“fabric:”URI 方案的应用程序全名。This is typically the full name of the application without the 'fabric:' URI scheme. 从版本 6.0 开始,分层名称以“~”字符隔开。Starting from version 6.0, hierarchical names are delimited with the "~" character. 例如,如果应用程序名称为“fabric:/myapp/app1”,则 6.0 及更高版本中的应用程序标识为“myapp~app1”,在以前的版本中为“myapp/app1”。For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
--node-name [必需]--node-name [Required] 节点的名称。The name of the node.
--partition-id--partition-id 分区的标识。The identity of the partition.
--service-manifest-name--service-manifest-name 在 Service Fabric 群集中注册为应用程序类型一部分的服务清单的名称。The name of a service manifest registered as part of an application type in a Service Fabric cluster.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica healthsfctl replica health

获取 Service Fabric 有状态服务副本或无状态服务实例的运行状况。Gets the health of a Service Fabric stateful service replica or stateless service instance.

获取 Service Fabric 副本的运行状况。Gets the health of a Service Fabric replica. 使用 EventsHealthStateFilter 可以根据运行状态筛选针对副本报告的运行状况事件的集合。Use EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.

参数Arguments

参数Argument 说明Description
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 副本的标识符。The identifier of the replica.
--events-health-state-filter--events-health-state-filter 用于根据运行状况筛选返回的 HealthEvent 对象集合。Allows filtering the collection of HealthEvent objects returned based on health state. 此参数的可能值包括以下运行状态之一的整数值。The possible values for this parameter include integer value of one of the following health states. 仅返回与筛选器匹配的事件。Only events that match the filter are returned. 所有事件用于评估聚合运行状态。All events are used to evaluate the aggregated health state. 如果未指定,则返回所有项。If not specified, all entries are returned. 状态值为基于标志的枚举,因此该值可以是使用按位“OR”运算符获取的值的组合。The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. 例如,如果提供的值为 6,则返回 HealthState 值为 OK (2) 和 Warning (4) 的所有事件。For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.
- Default - 默认值。- Default - Default value. 匹配任何 HealthState。Matches any HealthState. 值为 0。The value is zero.
- None - 不与任何 HealthState 值匹配的筛选器。- None - Filter that doesn't match any HealthState value. 未返回有关给定状态集合的结果时使用。Used in order to return no results on a given collection of states. 值为 1。The value is 1.
- Ok - 与 HealthState 值为 OK 的输入匹配的筛选器。- Ok - Filter that matches input with HealthState value Ok. 值为 2。The value is 2.
- Warning - 与 HealthState 值为 Warning 的输入匹配的筛选器。- Warning - Filter that matches input with HealthState value Warning. 值为 4。The value is 4.
- Error - 与 HealthState 值为 Error 的输入匹配的筛选器。- Error - Filter that matches input with HealthState value Error. 值为 8。The value is 8.
- All - 与具有任意 HealthState 值的输入匹配的筛选器。- All - Filter that matches input with any HealthState value. 值为 65535。The value is 65535.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica infosfctl replica info

获取有关 Service Fabric 分区的副本的信息。Gets the information about a replica of a Service Fabric partition.

响应包括 ID、角色、状态、运行状况、节点名称、运行时间和有关副本的其他详细信息。The response includes the ID, role, status, health, node name, uptime, and other details about the replica.

参数Arguments

参数Argument 说明Description
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 副本的标识符。The identifier of the replica.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica listsfctl replica list

获取有关 Service Fabric 服务分区的副本的信息。Gets the information about replicas of a Service Fabric service partition.

GetReplicas 终结点返回有关指定分区的副本的信息。The GetReplicas endpoint returns information about the replicas of the specified partition. 响应包括 ID、角色、状态、运行状况、节点名称、运行时间和有关副本的其他详细信息。The response includes the ID, role, status, health, node name, uptime, and other details about the replica.

参数Arguments

参数Argument 说明Description
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--continuation-token--continuation-token 继续标记参数用于获取下一组结果。The continuation token parameter is used to obtain next set of results. 如果单个响应无法容纳来自系统的结果,则 API 响应中包括含有非空值的继续标记。A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. 当此值传递到下一个 API 调用时,API 返回下一组结果。When this value is passed to the next API call, the API returns next set of results. 如果没有更多结果,则继续标记不包含值。If there are no further results, then the continuation token does not contain a value. 不应将此参数的值进行 URL 编码。The value of this parameter should not be URL encoded.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica removesfctl replica remove

删除节点上运行的服务副本。Removes a service replica running on a node.

此 API 通过从 Service Fabric 群集中删除副本来模拟 Service Fabric 副本故障。This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. 删除操作会关闭副本,将副本转换为“无”角色,然后从群集中删除副本的所有状态信息。The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. 此 API 测试副本状态删除路径,并通过客户端 API 模拟报告错误永久路径。This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. 警告 - 使用此 API 时不会执行任何安全检查。Warning - There are no safety checks performed when this API is used. 不当地使用此 API 可能导致有状态服务的数据丢失。Incorrect use of this API can lead to data loss for stateful services. 此外,forceRemove 标志会影响同一进程中承载的所有其他副本。In addition, the forceRemove flag impacts all other replicas hosted in the same process.

参数Arguments

参数Argument 说明Description
--node-name [必需]--node-name [Required] 节点的名称。The name of the node.
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 副本的标识符。The identifier of the replica.
--force-remove--force-remove 强制删除 Service Fabric 应用程序或服务,跳过正常关闭序列。Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. 若因服务代码中的问题而无法正常关闭副本,导致应用程序或服务删除超时,可使用此参数强制删除该应用程序或服务。This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica report-healthsfctl replica report-health

发送有关 Service Fabric 副本的运行状况报告。Sends a health report on the Service Fabric replica.

报告指定的 Service Fabric 副本的运行状况状态。Reports health state of the specified Service Fabric replica. 该报告必须包含有关运行状况报告及其所报告属性的源的信息。The report must contain the information about the source of the health report and property on which it is reported. 该报告将发送到 Service Fabric 网关副本,后者会将其转发到运行状况存储。The report is sent to a Service Fabric gateway Replica, which forwards to the health store. 该报告可能被网关接受但被运行状况存储在执行额外的验证后拒绝。The report may be accepted by the gateway, but rejected by the health store after extra validation. 例如,运行状况存储可能会由于无效的参数(如过时的序列号)而拒绝该报告。For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. 若要了解该报告是否已应用于运行状况存储,请运行 get replica health 并检查该报告是否显示在 HealthEvents 部分中。To see whether the report was applied in the health store, run get replica health and check that the report appears in the HealthEvents section.

参数Arguments

参数Argument 说明Description
--health-property [必需]--health-property [Required] 运行状况信息的属性。The property of the health information.

一个实体可以有不同属性的运行状况报告。An entity can have health reports for different properties. 该属性是一个字符串,不是固定的枚举,因此可使报告器灵活地对触发报告的状态条件进行分类。The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. 例如,SourceId 为“LocalWatchdog”的报告器可以监视节点上的可用磁盘的状态,因此它可以报告该节点的“AvailableDisk”属性。For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. 同一报告器可以监视节点连接,因此它可以报告同一节点的“Connectivity”属性。The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. 在运行状况存储中,这些报告均被视为指定节点的单独运行状况事件。In the health store, these reports are treated as separate health events for the specified node. 与 SourceId 一起,该属性唯一地标识运行状况信息。Together with the SourceId, the property uniquely identifies the health information.
--health-state [必需]--health-state [Required] 可能的值包括:“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”。Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'.
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 分区的标识。The identity of the partition.
--source-id [必需]--source-id [Required] 标识已生成运行状况信息的客户端/监视程序/系统组件的源名称。The source name that identifies the client/watchdog/system component that generated the health information.
--description--description 运行状况信息的说明。The description of the health information.

它表示用于添加有关该报告的用户可读信息的自定义文本。It represents free text used to add human readable information about the report. 该说明的最大字符串长度为 4096 个字符。The maximum string length for the description is 4096 characters. 如果所提供字符串的长度大于该值,它将被自动截断。If the provided string is longer, it will be automatically truncated. 截断时,该说明的末尾字符包含一个标记“[Truncated]”,并且总字符串大小为 4096 个字符。When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. 该标记的存在向用户指示截断已发生。The presence of the marker indicates to users that truncation occurred. 请注意,当截断时,该说明包含来自原始字符串的 4096 个以内的字符。Note that when truncated, the description has less than 4096 characters from the original string.
--immediate--immediate 一个用于指示是否应立即发送报告的标志。A flag that indicates whether the report should be sent immediately.

运行状况报告将发送到 Service Fabric 网关应用程序,后者会将其转发到运行状况存储。A health report is sent to a Service Fabric gateway Application, which forwards to the health store. 如果 Immediate 设置为 true,则报告将立即从 HTTP 网关发送至运行状况存储,而无论 HTTP 网关应用程序使用的 Fabric 客户端设置如何。If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. 这对于应尽快发送的关键报告十分有用。This is useful for critical reports that should be sent as soon as possible. 由于计时和其他情况,发送报告可能仍会失败,例如,在 HTTP 网关已关闭或消息无法到达网关的情况下。Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. 如果 Immediate 设置为 false,则报告将基于来自 HTTP 网关的运行状况客户端设置发送。If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. 因此,系统将根据 HealthReportSendInterval 配置对其进行批处理。Therefore, it will be batched according to the HealthReportSendInterval configuration. 这是建议的设置,因为它可让运行状况客户端优化发往运行状况存储的运行状况报告消息以及运行状况报告处理。This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. 默认情况下,报告不立即发送。By default, reports are not sent immediately.
--remove-when-expired--remove-when-expired 该值指示是否在报告过期时从运行状况存储删除该报告。Value that indicates whether the report is removed from health store when it expires.

如果设置为 true,报告在过期后将从运行状况存储中删除。If set to true, the report is removed from the health store after it expires. 如果设置为 false,报告在过期时将被视为错误。If set to false, the report is treated as an error when expired. 此属性的值在默认情况下为 false。The value of this property is false by default. 当客户端定期报告时,它们应将 RemoveWhenExpired 设置为 false(默认值)。When clients report periodically, they should set RemoveWhenExpired false (default). 这样,如果报告器有问题(例如死锁)并且无法报告,那么在运行状况报告过期时该实体就会被评估为处于错误状态。This way, is the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. 这会将该实体标记为处于“Error”运行状况状态。This flags the entity as being in Error health state.
--sequence-number--sequence-number 此运行状况报告的序列号(采用数字字符串形式)。The sequence number for this health report as a numeric string.

报告序列号由运行状况存储用来检测过时的报告。The report sequence number is used by the health store to detect stale reports. 如果未指定,序列号将在报告被添加时由运行状况客户端自动生成。If not specified, a sequence number is auto-generated by the health client when a report is added.
--service-kind--service-kind 为其报告运行状况的服务副本的类型(无状态或有状态)。The kind of service replica (stateless or stateful) for which the health is being reported. 以下是可能的值: “Stateless”、“Stateful”。Following are the possible values: 'Stateless', 'Stateful'. 默认值: Stateful。Default: Stateful.
--timeout -t--timeout -t 默认值: 60。Default: 60.
--ttl--ttl 此运行状况报告保持有效的持续时间。The duration for which this health report is valid. 此字段将 ISO8601 格式用于指定该持续时间。This field uses ISO8601 format for specifying the duration.

当客户端定期报告时,它们应以高于生存时间的频率发送报告。When clients report periodically, they should send reports with higher frequency than time to live. 如果客户端以非定期的方式报告,它们可以将生存时间设置为无限。If clients report on transition, they can set the time to live to infinite. 生存时间过期时,包含运行状况信息的运行状况事件将从运行状况存储中删除(如果 RemoveWhenExpired 为 true),或者将会评估为处于错误状态(如果 RemoveWhenExpired 为 false)。When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. 如果未指定,生存时间将默认为无限值。If not specified, time to live defaults to infinite value.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

sfctl replica restartsfctl replica restart

重启节点上运行的持久性服务的服务副本。Restarts a service replica of a persisted service running on a node.

重启节点上运行的持久性服务的服务副本。Restarts a service replica of a persisted service running on a node. 警告 - 使用此 API 时不会执行任何安全检查。Warning - There are no safety checks performed when this API is used. 不当地使用此 API 可能导致有状态服务失去可用性。Incorrect use of this API can lead to availability loss for stateful services.

参数Arguments

参数Argument 说明Description
--node-name [必需]--node-name [Required] 节点的名称。The name of the node.
--partition-id [必需]--partition-id [Required] 分区的标识。The identity of the partition.
--replica-id [必需]--replica-id [Required] 副本的标识符。The identifier of the replica.
--timeout -t--timeout -t 执行操作的服务器超时,以秒为单位。The server timeout for performing the operation in seconds. 此超时指定客户端可以等待请求的操作完成的持续时间。This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. 此参数的默认值为 60 秒。The default value for this parameter is 60 seconds. 默认值: 60。Default: 60.

全局参数Global Arguments

参数Argument 说明Description
--debug--debug 提高日志记录详细程度以显示所有调试日志。Increase logging verbosity to show all debug logs.
--help -h--help -h 显示此帮助消息并退出。Show this help message and exit.
--output -o--output -o 输出格式。Output format. 允许的值: json、jsonc、table、tsv。Allowed values: json, jsonc, table, tsv. 默认值: json。Default: json.
--query--query JMESPath 查询字符串。JMESPath query string. 有关详细信息和示例,请参阅 http://jmespath.org/。See http://jmespath.org/ for more information and examples.
--verbose--verbose 提高日志记录详细程度。Increase logging verbosity. 使用 --debug 获取完整的调试日志。Use --debug for full debug logs.

后续步骤Next steps