sfctl service
建立、刪除及管理服務、服務類型和服務套件。
命令
| 命令 | 描述 |
|---|---|
| app-name | 取得服務的 Service Fabric 應用程式名稱。 |
| code-package-list | 取得在 Service Fabric 節點上部署的程式代碼套件清單。 |
| create | 建立指定的 Service Fabric 服務。 |
| delete | 刪除現有的 Service Fabric 服務。 |
| deployed-type | 取得在 Service Fabric 叢集中節點上部署之應用程式之指定服務類型的相關信息。 |
| deployed-type-list | 取得清單，其中包含 Service Fabric 叢集中部署之節點上之應用程式之服務類型的相關信息。 |
| description | 取得現有 Service Fabric 服務的描述。 |
| get-container-logs | 取得在 Service Fabric 節點上部署之容器的容器記錄。 |
| health | 取得指定 Service Fabric 服務的健康情況。 |
| 資訊 | 取得屬於 Service Fabric 應用程式之特定服務的相關信息。 |
| 清單 | 取得屬於應用程式識別碼所指定應用程式的所有服務相關信息。 |
| 資訊清單 | 取得描述服務類型的指令清單。 |
| package-deploy | 將與指定服務指令清單相關聯的套件下載至指定節點上的映像快取。 |
| package-health | 取得針對 Service Fabric 節點和應用程式所部署之特定應用程式之服務套件健康情況的相關信息。 |
| package-info | 取得與指定名稱完全相符之 Service Fabric 節點上部署的服務套件清單。 |
| package-list | 取得部署在 Service Fabric 節點上的服務套件清單。 |
| recover | 表示 Service Fabric 叢集應該嘗試復原目前停滯在仲裁遺失中的指定服務。 |
| report-health | 傳送 Service Fabric 服務的健康情況報告。 |
| resolve | 解析 Service Fabric 磁碟分區。 |
| type-list | 取得清單，其中包含 Service Fabric 叢集中佈建應用程式類型所支援之服務類型的相關信息。 |
| update | 使用指定的更新描述來更新指定的服務。 |
sfctl service app-name
取得服務的 Service Fabric 應用程式名稱。
取得指定服務的應用程式名稱。 如果服務標識碼不存在，則會傳回 404 FABRIC_E_SERVICE_DOES_NOT_EXIST錯誤。
引數
| Argument | 描述 |
|---|---|
| --service-id [必要] | 服務的身分識別。 此標識碼通常是沒有 'fabric：' URI 配置之服務的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果服務名稱是 「fabric：/myapp/app1/svc1“，則服務識別在 6.0+ 中會是 ”myapp~app1~svc1“，而舊版中的 ”myapp/app1/svc1“。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service code-package-list
取得在 Service Fabric 節點上部署的程式代碼套件清單。
取得在指定應用程式的 Service Fabric 節點上部署的程式代碼套件清單。
引數
| Argument | 描述 |
|---|---|
| --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 | 在 Service Fabric 叢集中註冊為應用程式類型一部分的服務指令清單名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service create
建立指定的 Service Fabric 服務。
引數
| Argument | 描述 |
|---|---|
| --app-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層的名稱會以 '~' 字元分隔。 例如，如果應用程式名稱是 'fabric:/myapp/app1'，則應用程式識別在 6.0+ 中會是 'myapp~app1'，而在舊版中會是 'myapp/app1'。 |
| --name [必要] | 服務的名稱。 這應該是應用程式識別碼的子系。 這是包含 fabric\: URI 的完整名稱。 例如，服務 fabric\:/A/B 是應用程式的子系 fabric\:/A。 |
| --service-type [必要] | 服務類型的名稱。 |
| --activation-mode | 服務套件的啟用模式。 |
| --約束 | 放置條件約束做為字串。 放置條件約束是節點屬性上的布爾表達式，允許根據服務需求將服務限制為特定節點。 例如，若要將服務放在 NodeType 為藍色的節點上，請指定下列專案：“NodeColor == blue”。 |
| --correlated-service | 要與其相互關聯的目標服務名稱。 |
| --相關 | 使用對齊親和性將服務與現有服務相互關聯。 |
| --dns-name | 要建立之服務的 DNS 名稱。 必須為此設定啟用 Service 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、、PreferPrimaryDomainRequireDomain、 RequireDomainDistribution。 |
| --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。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service delete
刪除現有的 Service Fabric 服務。
必須先建立服務，才能刪除服務。 根據預設，Service Fabric 會嘗試以正常方式關閉服務複本，然後刪除服務。 不過，如果服務正常關閉複本時發生問題，刪除作業可能需要很長的時間或停滯。 使用選擇性的 ForceRemove 旗標來略過正常關閉順序，並強制刪除服務。
引數
| Argument | 描述 |
|---|---|
| --service-id [必要] | 服務的身分識別。 此標識碼通常是沒有 'fabric：' URI 配置之服務的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果服務名稱是 「fabric：/myapp/app1/svc1“，則服務識別在 6.0+ 中會是 ”myapp~app1~svc1“，而舊版中的 ”myapp/app1/svc1“。 |
| --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 service deployed-type
取得在 Service Fabric 叢集中節點上部署之應用程式之指定服務類型的相關信息。
取得清單，其中包含 Service Fabric 叢集中部署之節點上之應用程式的特定服務類型相關信息。 回應包含服務類型的名稱、其註冊狀態、註冊它的程式代碼套件，以及服務套件的啟用標識碼。 每個專案都代表服務類型的一個啟用，以啟用標識符區分。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --node-name [必要] | 節點的名稱。 |
| --service-type-name [必要] | 指定 Service Fabric 服務類型的名稱。 |
| --service-manifest-name | 用來篩選已部署服務類型資訊清單的服務指令清單名稱。 如果指定，回應只會包含此服務指令清單中定義之服務類型的相關信息。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service deployed-type-list
取得清單，其中包含 Service Fabric 叢集中部署之節點上之應用程式之服務類型的相關信息。
取得清單，其中包含 Service Fabric 叢集中部署之節點上之應用程式之服務類型的相關信息。 回應包含服務類型的名稱、其註冊狀態、註冊它的程式代碼套件，以及服務套件的啟用標識碼。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --node-name [必要] | 節點的名稱。 |
| --service-manifest-name | 用來篩選已部署服務類型資訊清單的服務指令清單名稱。 如果指定，回應只會包含此服務指令清單中定義之服務類型的相關信息。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service description
取得現有 Service Fabric 服務的描述。
取得現有 Service Fabric 服務的描述。 必須先建立服務，才能取得服務的描述。
引數
| Argument | 描述 |
|---|---|
| --service-id [必要] | 服務的身分識別。 此標識碼通常是沒有 'fabric：' URI 配置之服務的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果服務名稱是 「fabric：/myapp/app1/svc1“，則服務識別在 6.0+ 中會是 ”myapp~app1~svc1“，而舊版中的 ”myapp/app1/svc1“。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service get-container-logs
取得在 Service Fabric 節點上部署之容器的容器記錄。
取得針對指定程式代碼套件在 Service Fabric 節點上部署之容器的容器記錄。
引數
| Argument | 描述 |
|---|---|
| --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 [必要] | 在 Service Fabric 叢集中註冊為應用程式類型一部分的服務指令清單名稱。 |
| --以前 | 指定是否要從程式代碼封裝實例的結束/無效容器取得容器記錄。 |
| --尾巴 | 要從記錄結尾顯示的行數。 預設值為 100。 顯示完整記錄的 『all』。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl 服務健康情況
取得指定 Service Fabric 服務的健康情況。
取得指定服務的健康情況資訊。 使用 EventsHealthStateFilter，根據健康情況狀態篩選服務所報告的健康情況事件集合。 使用 PartitionsHealthStateFilter 篩選傳回的數據分割集合。 如果您指定健康狀態存放區中不存在的服務，則此要求會傳回錯誤。
引數
| Argument | 描述 |
|---|---|
| --service-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。 值為零。 - 無 - 不符合任何 HealthState 值的篩選。 用來傳回指定狀態集合上沒有結果。 值為 1。 - 確定 - 符合輸入的篩選與 HealthState 值 Ok。 值為 2。 - 警告 - 符合輸入與 HealthState 值 Warning 的篩選條件。 值為 4。 - 錯誤 - 符合輸入與 HealthState 值 Error 的篩選條件。 值為 8。 - 全部 - 符合任何 HealthState 值的輸入的篩選條件。 值為 65535。 |
| --exclude-health-statistics | 指出健康情況統計數據是否應該當做查詢結果的一部分傳回。 False 預設為 False。 統計數據顯示健全狀況狀態為Ok、Warning和Error的子實體數目。 |
| --partitions-health-state-filter | 允許根據服務健康狀態查詢結果所傳回的數據分割健全狀況狀態對象進行篩選。 此參數的可能值包括下列其中一個健康情況狀態的整數值。 只會傳回符合篩選條件的分割區。 所有分割區都會用來評估匯總的健康情況狀態。 如果未指定，則會傳回所有專案。 狀態值是以旗標為基礎的列舉，因此值可以是使用位 『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 service info
取得屬於 Service Fabric 應用程式之特定服務的相關信息。
傳回屬於指定 Service Fabric 應用程式之指定服務的相關信息。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --service-id [必要] | 服務的身分識別。 此標識碼通常是沒有 'fabric：' URI 配置之服務的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果服務名稱是 「fabric：/myapp/app1/svc1“，則服務識別在 6.0+ 中會是 ”myapp~app1~svc1“，而舊版中的 ”myapp/app1/svc1“。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service list
取得屬於應用程式識別碼所指定應用程式的所有服務相關信息。
傳回屬於應用程式識別碼所指定之應用程式的所有服務相關信息。
引數
| Argument | 描述 |
|---|---|
| --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。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service manifest
取得描述服務類型的指令清單。
取得描述服務類型的指令清單。 回應包含服務指令清單 XML 做為字串。
引數
| Argument | 描述 |
|---|---|
| --application-type-name [必要] | 應用程式類型的名稱。 |
| --application-type-version [必要] | 應用程式類型的版本。 |
| --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 service package-deploy
將與指定服務指令清單相關聯的套件下載至指定節點上的映像快取。
引數
| Argument | 描述 |
|---|---|
| --app-type-name [必要] | 對應要求之服務指令清單的應用程式指令清單名稱。 |
| --app-type-version [必要] | 對應要求之服務指令清單的應用程式指令清單版本。 |
| --node-name [必要] | 節點的名稱。 |
| --service-manifest-name [必要] | 與即將下載之套件相關聯的服務指令清單名稱。 |
| --share-policy | 共用原則的 JSON 編碼清單。 每個共享原則元素都是由 「名稱」和「範圍」所組成。 名稱會對應至要共用的程式代碼、組態或數據套件名稱。 範圍可以是 'None'、'All'、'Code'、'Config' 或 'Data'。 |
| --timeout -t | 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service package-health
取得針對 Service Fabric 節點和應用程式所部署之特定應用程式之服務套件健康情況的相關信息。
取得 Service Fabric 節點上所部署特定應用程式之服務套件健康情況的相關信息。 使用 EventsHealthStateFilter，根據健康情況狀態，選擇性地篩選所部署服務套件上所報告 HealthEvent 物件的集合。
引數
| Argument | 描述 |
|---|---|
| --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。 值為零。 - 無 - 不符合任何 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 service package-info
取得與指定名稱完全相符之 Service Fabric 節點上部署的服務套件清單。
傳回所指定應用程式在 Service Fabric 節點上部署之服務套件的相關信息。 這些結果是名稱與指定為 參數的服務套件名稱完全相符的服務套件。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --node-name [必要] | 節點的名稱。 |
| --service-package-name [必要] | 服務套件的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service package-list
取得部署在 Service Fabric 節點上的服務套件清單。
傳回所指定應用程式在 Service Fabric 節點上部署之服務套件的相關信息。
引數
| Argument | 描述 |
|---|---|
| --application-id [必要] | 應用程式的身分識別。 這通常是沒有 'fabric:' URI 配置之應用程式的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果應用程式名稱是 「fabric：/myapp/app1」，則應用程式身分識別在 6.0+ 中會是 「myapp~app1」，而舊版中的 「myapp/app1」。。 |
| --node-name [必要] | 節點的名稱。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service recover
表示 Service Fabric 叢集應該嘗試復原目前停滯在仲裁遺失中的指定服務。
表示 Service Fabric 叢集應該嘗試復原目前停滯在仲裁遺失中的指定服務。 只有在已知無法復原關閉的複本時，才應該執行這項作業。 不正確使用此 API 可能會導致潛在的數據遺失。
引數
| Argument | 描述 |
|---|---|
| --service-id [必要] | 服務的身分識別。 此標識碼通常是沒有 'fabric：' URI 配置之服務的完整名稱。 從 6.0 版開始，階層式名稱會以 “~” 字元分隔。 例如，如果服務名稱是 「fabric：/myapp/app1/svc1“，則服務識別在 6.0+ 中會是 ”myapp~app1~svc1“，而舊版中的 ”myapp/app1/svc1“。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service report-health
傳送 Service Fabric 服務的健康情況報告。
報告指定 Service Fabric 服務的健康情況狀態。 報表必須包含其報告之健康情況報告來源和屬性的相關信息。 報表會傳送至 Service Fabric 閘道服務，此服務會轉送至健康狀態存放區。 網關可以接受報告，但在額外的驗證之後，健康狀態存放區會拒絕。 例如，健康狀態存放區可能會因為無效的參數而拒絕報告，例如過時的序號。 若要查看報表是否已套用在健康狀態存放區中，請檢查報告是否出現在服務的健康情況事件中。
引數
| Argument | 描述 |
|---|---|
| --health-property [必要] | 健康情況信息的屬性。 實體可以有不同屬性的健康情況報告。 屬性是字串，而不是固定列舉，可讓記者彈性地分類觸發報表的狀態條件。 例如，具有SourceId「LocalWatchdog」 的記者可以監視節點上可用磁碟的狀態，以便報告該節點上的 「AvailableDisk」 屬性。 相同的記者可以監視節點連線能力，因此它可以報告相同節點上的屬性「連線能力」。 在健康狀態存放區中，這些報告會被視為指定節點的個別健康情況事件。 屬性與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 [必要] | 識別產生健康情況資訊之用戶端/監視程式/系統元件的來源名稱。 |
| --描述 | 健康情況資訊的描述。 它代表用來新增人類可讀報表資訊的自由文字。 描述的最大字串長度為4096個字元。 如果提供的字串較長，則會自動截斷。 截斷時，描述的最後一個字元包含標記 “[Truncated]”，而字串大小總計為 4096 個字元。 標記的存在表示發生截斷的使用者。 請注意，截斷時，描述的原始字串少於 4096 個字元。 |
| --立即的 | 指出是否應立即傳送報表的旗標。 健康情況報告會傳送至 Service Fabric 閘道應用程式，此應用程式會轉送至健康狀態存放區。 如果 Immediate 設定為 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，則會在錯誤時進行評估。 如果未指定，存留時間預設為無限值。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service resolve
解析 Service Fabric 磁碟分區。
解析 Service Fabric 服務分割區，以取得服務複本的端點。
引數
| Argument | 描述 |
|---|---|
| --service-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，則需要此專案。 這不是分割區標識碼，而是整數索引鍵值或分割區標識符的名稱。 例如，如果您的服務使用從 0 到 10 的範圍分割，則 PartitionKeyValue 會是該範圍內的整數。 查詢服務描述以查看範圍或名稱。 |
| --previous-rsp-version | 先前接收之回應之 [版本] 欄位中的值。 如果使用者知道先前取得的結果已過時，則這是必要的。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service type-list
取得清單，其中包含 Service Fabric 叢集中佈建應用程式類型所支援之服務類型的相關信息。
取得清單，其中包含 Service Fabric 叢集中佈建應用程式類型所支援之服務類型的相關信息。 所提供的應用程式類型必須存在。 否則會傳回 404 狀態。
引數
| Argument | 描述 |
|---|---|
| --application-type-name [必要] | 應用程式類型的名稱。 |
| --application-type-version [必要] | 應用程式類型的版本。 |
| --timeout -t | 伺服器逾時，以秒為單位執行作業。 此逾時會指定客戶端願意等候要求作業完成的時間持續時間。 此參數的預設值為 60 秒。 預設值：60。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |
sfctl service update
使用指定的更新描述來更新指定的服務。
引數
| Argument | 描述 |
|---|---|
| --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、、PreferPrimaryDomainRequireDomain、 RequireDomainDistribution。 |
| --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。 |
全域引數
| Argument | 描述 |
|---|---|
| --debug | 增加記錄詳細資訊，以顯示所有偵錯記錄。 |
| --help -h | 顯示此說明訊息並結束。 |
| --output -o | 輸出格式。 允許的值：json、jsonc、table、tsv。 預設值：json。 |
| --查詢 | JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。 |
| --verbose | 增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。 |