全部產品
Search

搜尋本產品

    Platform For AI：DescribeServiceRollout

    文件中心

    Platform For AI：DescribeServiceRollout

    更新時間：Sep 24, 2026

    查看服務更新計畫。

    介面說明

    請求說明

    • 該介面用於查詢特定服務的發布策略（Rollout）設定和當前執行狀態。

    • 返回的資訊包括但不限於發布策略的具體參數、當前發布進度等。

    • 請求時需提供ClusterId和服務名稱ServiceName作為路徑參數。

    • 注意，請求速率限制為每秒最多 100 次。

    • 如果服務不存在或未建立發布策略，呼叫此介面將返回錯誤。

    • 返回的狀態是即時查詢的結果，可能會隨時間而變化，請根據實際需要調整輪詢間隔。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    eas:DescribeServiceRollout

    get

    *全部資源。

    *

    		 無 無

    請求文法

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

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    ClusterId

    string

    否

    服務所在地域 ID。

    cn-shanghai
    ServiceName

    string

    否

    服務名稱。

    foo

    請求參數

    名稱

    類型

    必填

    描述

    樣本值

    當前API無需請求參數

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    回應 Body。

    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

    批次間隔。兩次發布之間的等待時間。

    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

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
    }
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。