DescribeServiceRollout - 查看服务更新计划 - 人工智能平台 PAI

查看服务更新计划

接口说明

请求说明

该接口用于查询特定服务的发布策略（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"
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。