sfctl replica
管理屬於服務分割區的複本。
命令
| 命令 | 描述 |
|---|---|
| 部署 | 取得在 Service Fabric 節點上部署之複本的詳細數據。 |
| deployed-list | 取得在 Service Fabric 節點上部署的複本清單。 |
| health | 取得 Service Fabric 具狀態服務複本或無狀態服務實例的健康情況。 |
| 資訊 | 取得 Service Fabric 分割區複本的相關信息。 |
| 清單 | 取得 Service Fabric 服務分割區複本的相關信息。 |
| remove | 拿掉節點上執行的服務複本。 |
| report-health | 在 Service Fabric 複本上傳送健康情況報告。 |
| restart | 重新啟動節點上執行之持續性服務的服務複本。 |
sfctl replica deployed
取得在 Service Fabric 節點上部署之複本的詳細數據。
取得部署在 Service Fabric 節點上之複本的詳細數據。 此資訊包括服務種類、服務名稱、目前服務作業、目前服務作業開始日期時間、分割區標識碼、復本/實例標識符、報告載入和其他資訊。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 複本的標識碼。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica deployed-list
取得在 Service Fabric 節點上部署的複本清單。
取得清單，其中包含在 Service Fabric 節點上部署之復本的相關信息。 資訊包括分割區標識碼、複本標識碼、複本狀態、服務名稱、服務類型名稱及其他資訊。 使用 PartitionId 或 ServiceManifestName 查詢參數，傳回符合這些參數指定值之已部署複本的相關信息。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --node-name [必要] | 節點的名稱。 |
| --partition-id | 數據分割的識別。 |
| --service-manifest-name | 在 Service Fabric 叢集中註冊為應用程式類型一部分的服務指令清單名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica health
取得 Service Fabric 具狀態服務複本或無狀態服務實例的健康情況。
取得 Service Fabric 複本的健康情況。 使用 EventsHealthStateFilter，根據健康情況狀態篩選複本所報告的健康情況事件集合。
引數
| Argument | 描述 |
|---|---|
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 複本的標識碼。 |
| --events-health-state-filter | 允許根據健康情況狀態篩選傳回的HealthEvent物件集合。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選的事件。 所有事件都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是這些值的組合，使用位 『OR』 運算子取得。 例如，如果提供的值為 6，則會傳回 HealthState 值為 OK （2） 和 Warning （4） 的所有事件。 - 預設值 - 預設值。 符合任何 HealthState。 值為零。 - 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。 - 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。 - 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。 - 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。 - 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica info
取得 Service Fabric 分割區複本的相關信息。
回應包含有關複本的標識碼、角色、狀態、健康情況、節點名稱、運行時間和其他詳細數據。
引數
| Argument | 描述 |
|---|---|
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 複本的標識碼。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica list
取得 Service Fabric 服務分割區複本的相關信息。
GetReplicas 端點會傳回指定分割區複本的相關信息。 回應包含有關複本的標識碼、角色、狀態、健康情況、節點名稱、運行時間和其他詳細數據。
引數
| Argument | 描述 |
|---|---|
| --partition-id [必要] | 數據分割的識別。 |
| --continuation-token | 接續令牌參數是用來取得下一組結果。 當來自系統的結果不符合單一回應時，API 回應中會包含具有非空白值的接續令牌。 當此值傳遞至下一個 API 呼叫時，API 會傳回下一組結果。 如果沒有進一步的結果，接續令牌就不會包含值。 此參數的值不應該經過 URL 編碼。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica remove
拿掉節點上執行的服務複本。
此 API 會藉由從 Service Fabric 叢集移除複本來模擬 Service Fabric 複本失敗。 拿掉會關閉複本、將複本轉換為無角色，然後從叢集移除複本的所有狀態資訊。 此 API 會測試複本狀態移除路徑，並透過用戶端 API 模擬報告錯誤永久路徑。 警告 - 使用此 API 時不會執行任何安全檢查。 不正確使用此 API 可能會導致具狀態服務的數據遺失。 此外，forceRemove 旗標會影響相同進程中裝載的所有其他複本。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 複本的標識碼。 |
| --force-remove | 在不經過正常關機順序的情況下，強制移除 Service Fabric 應用程式或服務。 此參數可用來強制刪除因服務程式代碼中導致無法正常關閉複本之服務程式代碼的問題而逾時刪除的應用程式或服務。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica report-health
在 Service Fabric 複本上傳送健康情況報告。
報告指定 Service Fabric 複本的健康情況狀態。 報表必須包含其報告之健康情況報告來源和屬性的相關信息。 報表會傳送至 Service Fabric 閘道復本，此複本會轉送至健康狀態存放區。 網關可以接受報告，但在額外的驗證之後，健康狀態存放區會拒絕。 例如，健康狀態存放區可能會因為無效的參數而拒絕報告，例如過時的序號。 若要查看報表是否已套用在健康狀態存放區中，請執行取得複本健康情況，並檢查報告是否出現在 HealthEvents 區段中。
引數
| Argument | 描述 |
|---|---|
| --health-property [必要] | 健康情況信息的屬性。 實體可以有不同屬性的健康情況報告。 屬性是字串，而不是固定列舉，可讓記者彈性地分類觸發報表的狀態條件。 例如，具有SourceId「LocalWatchdog」 的記者可以監視節點上可用磁碟的狀態，以便報告該節點上的 「AvailableDisk」 屬性。 相同的記者可以監視節點連線能力，因此它可以報告相同節點上的屬性「連線能力」。 在健康狀態存放區中，這些報告會被視為指定節點的個別健康情況事件。 屬性與SourceId一起，可唯一識別健康情況資訊。 |
| --health-state [必要] | 可能的值包括：『Invalid』、『Ok』、『Warning』、『Error』、『Unknown』。 |
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 數據分割的識別。 |
| --source-id [必要] | 識別產生健康情況資訊之用戶端/監視程式/系統元件的來源名稱。 |
| --描述 | 健康情況資訊的描述。 它代表用來新增人類可讀報表資訊的自由文字。 描述的最大字串長度為4096個字元。 如果提供的字串較長，則會自動截斷。 截斷時，描述的最後一個字元包含標記 “[Truncated]”，而字串大小總計為 4096 個字元。 標記的存在表示發生截斷的使用者。 請注意，截斷時，描述的原始字串少於 4096 個字元。 |
| --立即的 | 指出是否應立即傳送報表的旗標。 健康情況報告會傳送至 Service Fabric 閘道應用程式，此應用程式會轉送至健康狀態存放區。 如果 Immediate 設定為 true，則不論 HTTP 閘道應用程式所使用的網狀架構客戶端設定為何，報表都會立即從 HTTP 閘道傳送至健康狀態存放區。 這對於應儘快傳送的重要報告很有用。 根據計時和其他條件，傳送報告可能仍然失敗，例如，如果 HTTP 閘道已關閉或訊息未連線到閘道。 如果 [即時運算] 設定為 false，則會根據 HTTP 閘道的健康情況客戶端設定來傳送報告。 因此，它會根據 HealthReportSendInterval 組態進行批處理。 這是建議的設定，因為它可讓健康情況用戶端將健康情況報告訊息優化到健康狀態存放區，以及健康情況報告處理。 根據預設，報表不會立即傳送。 |
| --remove-when-expired | 值，指出報表在到期時是否從健康狀態存放區中移除。 如果設定為 true，報表會在到期後從健康狀態存放區中移除。 如果設定為 false，報表會在過期時被視為錯誤。 此屬性的值預設為 false。 當用戶端定期報告時，應該設定 RemoveWhenExpired false （預設值）。 如此一來，記者有問題（例如死結）且無法報告，實體會在健康情況報告到期時評估為錯誤。 這會將實體標示為處於錯誤健康狀態。 |
| --sequence-number | 此健康情況報告的序號為數值字串。 健康狀態存放區會使用報表序號來偵測過時的報告。 如果未指定，當加入報表時，健康情況用戶端會自動產生序號。 |
| --service-kind | 報告健康情況的服務複本類型（無狀態或具狀態）。 以下是可能的值：『無狀態』、『具狀態』。 默認值：具狀態。 |
| --timeout -t | 預設值：60。 |
| --ttl | 此健康情況報告有效的持續時間。 此欄位會使用ISO8601格式來指定持續時間。 當用戶端定期報告時，他們應該傳送頻率高於存留時間的報告。 如果客戶端回報轉換，他們可以將存留時間設定為無限。 存留時間到期時，如果 RemoveWhenExpired 為 true，則會從健康狀態存放區移除包含健康情況資訊的健全狀況事件，如果 RemoveWhenExpired false，則會在錯誤時進行評估。 如果未指定，存留時間預設為無限值。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl replica restart
重新啟動節點上執行之持續性服務的服務複本。
重新啟動節點上執行之持續性服務的服務複本。 警告 - 使用此 API 時不會執行任何安全檢查。 不正確使用此 API 可能會導致具狀態服務的可用性遺失。
引數
| Argument | 描述 |
|---|---|
| --node-name [必要] | 節點的名稱。 |
| --partition-id [必要] | 數據分割的識別。 |
| --replica-id [必要] | 複本的標識碼。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |