叫用基礎結構命令
叫用指定基礎結構服務執行個體上的系統管理命令。
對於設定一或多個基礎結構服務執行個體的叢集,此 API 提供將基礎結構特有的命令傳送至基礎結構服務特定執行個體的方法。
可用的命令和其對應的回應格式會根據叢集執行所在的基礎結構而有所不同。
這個 API 支援 Service Fabric 平台;這不表示直接從您的程式碼使用。
要求
方法 | 要求 URI |
---|---|
POST | /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout} |
參數
名稱 | 類型 | 必要 | Location |
---|---|---|---|
api-version |
字串 | 是 | 查詢 |
Command |
string | 是 | 查詢 |
ServiceId |
字串 | No | 查詢 |
timeout |
整數 (int64) | No | 查詢 |
api-version
類型:字串
必要:是
預設:6.0
API 的版本。 這是必要參數,其值必須是 '6.0'。
Service Fabric REST API 版本是以 API 引進或變更的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。 這是 API 的最新支援版本。 如果傳遞較低的 API 版本,傳回的回應可能會與本規格中所述的回應不同。
此外,執行時間也接受高於最新支援版本的任何版本,最高為目前版本的執行時間。 因此,如果最新的 API 版本是 6.0,但如果執行時間是 6.1,為了更容易撰寫用戶端,執行時間將會接受該 API 6.1 版。 不過,API 的行為會根據記載的 6.0 版本。
Command
類型:字串
必要:是
要叫用的命令文字。 命令的內容與基礎結構有關。
ServiceId
類型:字串
必要:否
基礎結構服務的識別。 這是不含 'fabric:' URI 配置的基礎結構服務完整名稱。 只有當叢集中有多個基礎結構服務執行個體正在執行時,才需要提供此參數。
timeout
類型:整數 (int64)
必要:否
預設:60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。
回應
HTTP 狀態碼 | 描述 | 回應結構描述 |
---|---|---|
200 (確定) | 基礎結構服務的回應。 回應格式是 JSON 資料流程。 回應的內容取決於發出的命令。 |
string |
所有其他狀態碼 | 詳細的錯誤回應。 |
FabricError |