すべてのプロダクト
Search

このプロダクト

    Platform For AI:DescribeServiceRollout

    ドキュメントセンター

    Platform For AI:DescribeServiceRollout

    最終更新日:Sep 24, 2026

    サービス更新プランを照会します。

    操作説明

    操作の説明

    • この操作は、特定のサービスのロールアウト構成と現在の実行ステータスを照会します。

    • 返される情報には、ロールアウト戦略の特定のパラメーターや現在のロールアウトの進行状況などが含まれますが、これらに限定されません。

    • リクエストのパスパラメーターとして ClusterId とサービス名 ServiceName を指定します。

    • リクエストのレート制限は、1 秒あたり 100 リクエストです。

    • サービスが存在しないか、ロールアウト戦略が作成されていない場合、この操作はエラーを返します。

    • 返されるステータスは、時間の経過とともに変化する可能性があるリアルタイムの照会結果です。必要に応じてポーリング間隔を調整してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    eas:DescribeServiceRollout

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET /api/v2/services/{ClusterId}/{ServiceName}/rollout HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    任意

    サービスが存在するクラスターのリージョン ID。

    cn-shanghai
    ServiceName

    string

    任意

    サービス名。

    foo

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディ。

    RequestId

    string

    リクエスト ID。各リクエストで返される一意の識別子で、トラブルシューティングとトレースに使用されます。

    40325405-579C-4D82****
    Rollout

    object

    ロールアウト戦略情報。戦略構成 (Strategy)、実行ステータス (Status)、およびレートが含まれます。

    Strategy

    object

    ロールアウト戦略構成。パーティションベースまたはバッチベースのロールアウトの特定の構成パラメーターが含まれます。

    Partition

    object

    パーティションロールアウト構成。このフィールドは、パーティションベースのロールアウト戦略が使用されている場合にのみ返されます。

    Partition

    string

    パーティション値。保持する古いレプリカの数またはパーセンテージを指定します。たとえば、50% は古いレプリカの 50% が保持されることを示します。

    50%
    Batch

    object

    バッチロールアウト構成。このフィールドは、バッチベースのロールアウト戦略が使用されている場合にのみ返されます。

    BatchSize

    string

    バッチサイズ。各バッチで更新するレプリカの数またはパーセンテージ。

    1
    Interval

    string

    バッチ間隔。2 つの連続するロールアウトバッチ間の待機時間。

    5m
    Status

    object

    ロールアウト実行ステータス。現在のロールアウトの進行状況と位相情報が含まれます。

    Phase

    string

    ロールアウト位相。有効な値:

    • Pending: ロールアウトの開始を待機中。

    • Running: ロールアウトが進行中。

    • Paused: ロールアウトが一時停止中。

    • Completed: ロールアウトが完了。

    • Failed: ロールアウトが失敗した。

    列挙値:

    • Failed :

      ロールアウトが失敗した。

    • Completed :

      ロールアウトが完了。

    • Running :

      ロールアウトが進行中。

    • Pending :

      ロールアウトの開始を待機中。

    • Paused :

      ロールアウトが一時停止中。

    Running
    TotalReplicas

    integer

    サービスのレプリカの総数。

    10
    UpdatedReplicas

    integer

    新しいバージョンに更新されたレプリカの数。

    5
    CurrentRevision

    string

    現在のリビジョン。現在実行中のバージョンの識別子。

    service-abc123-v1
    UpdateRevision

    string

    更新リビジョン。サービスの更新先となるターゲットバージョンの識別子。

    service-abc123-v2
    NextBatchStartTime

    string

    次のバッチが更新を開始する時間。YYYY/MM/DD HH:mm:ss のフォーマット。

    2026/05/08 16:10:56

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "40325405-579C-4D82****",
  "Rollout": {
    "Strategy": {
      "Partition": {
        "Partition": "50%"
      },
      "Batch": {
        "BatchSize": "1",
        "Interval": "5m"
      }
    },
    "Status": {
      "Phase": "Running",
      "TotalReplicas": 10,
      "UpdatedReplicas": 5,
      "CurrentRevision": "service-abc123-v1",
      "UpdateRevision": "service-abc123-v2",
      "NextBatchStartTime": "2026/05/08 16:10:56"
    }
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。