クラスター構成のアップグレードを開始する

  • [アーティクル]

Service Fabric スタンドアロン クラスターの構成のアップグレードを開始します。

指定された構成アップグレード パラメーターを検証し、パラメーターが有効であれば、クラスター構成のアップグレードを開始します。

Request

Method 要求 URI
POST /$/StartClusterConfigurationUpgrade?api-version=6.0&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
timeout integer (int64) いいえ クエリ
ClusterConfigurationUpgradeDescription ClusterConfigurationUpgradeDescription はい Body

api-version

型: string
必須: はい
既定値:

API のバージョン。 このパラメーターは必須であり、その値は '6.0' である必要があります。

Service Fabric REST API のバージョンは、API が導入または変更されたランタイム バージョンに基づいています。 Service Fabric ランタイムでは、複数のバージョンの API がサポートされています。 これは、サポートされている API の最新バージョンです。 より低い API バージョンが渡された場合、返される応答は、この仕様に記載されている応答とは異なる場合があります。

さらに、ランタイムは、現在のバージョンのランタイムまで、サポートされている最新バージョンより高いバージョンを受け入れます。 したがって、最新の API バージョンが 6.0 ですが、ランタイムが 6.1 の場合、クライアントの記述を容易にするために、ランタイムはその API のバージョン 6.1 を受け入れます。 ただし、API の動作は、文書化されている 6.0 バージョンに従います。

timeout

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

ClusterConfigurationUpgradeDescription

種類: ClusterConfigurationUpgradeDescription
必須: はい

スタンドアロン クラスター構成のアップグレードのパラメーター。

応答

HTTP 状態コード 説明 応答スキーマ
202 (承認済み) 正常な応答は、クラスター構成のアップグレードが開始されたことを意味します。 アップグレードの状態を取得するには、GetClusterConfigurationUpgradeStatus 操作を使用します。
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

Service Fabric スタンドアロン クラスターの構成のアップグレードを開始する

この例では、Service Fabric スタンドアロン クラスターの構成のアップグレードを開始する方法を示します。

要求

POST http://localhost:19080/$/StartClusterConfigurationUpgrade?api-version=6.0
本文
{
  "ClusterConfig": "<PutYourClusterConfigHere>",
  "ApplicationHealthPolicies": {
    "ApplicationHealthPolicyMap": [
      {
        "Key": "fabric:/samples/CalculatorApp",
        "Value": {
          "ConsiderWarningAsError": true,
          "MaxPercentUnhealthyDeployedApplications": "10",
          "DefaultServiceTypeHealthPolicy": {
            "MaxPercentUnhealthyPartitionsPerService": "0",
            "MaxPercentUnhealthyReplicasPerPartition": "0",
            "MaxPercentUnhealthyServices": "0"
          },
          "ServiceTypeHealthPolicyMap": [
            {
              "Key": "Svc1Type",
              "Value": {
                "MaxPercentUnhealthyPartitionsPerService": "0",
                "MaxPercentUnhealthyReplicasPerPartition": "0",
                "MaxPercentUnhealthyServices": "10"
              }
            }
          ]
        }
      }
    ]
  }
}

202 応答

本文

応答本文は空です。