ListPublishBatch - 查询发布批次 - 云安全中心

查询当前用户自定义升级发布批次。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:ListPublishBatch	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
UpgradeVersion	string	是	要升级目标版本。	0.0.9
CurrentPage	integer	是	分页查询时，当前页的页码。	1
PageSize	integer	是	分页查询时，显示每页数据的最大条数。	20
BatchName	string	否	发布批次名称。	批次1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1
PageInfo	object	分页信息。
CurrentPage	integer	分页查询时，显示的当前页的页码。	1
PageSize	integer	分页查询时，显示的每页数据的最大条数。	20
TotalCount	integer	返回数据的总条数。	25
BatchList	array<object>	批量发布任务的详细信息。
BatchList	object	批量发布任务的详细信息。
Version	string	目标要升级的版本号。	0.0.9
BatchName	string	发布批次名称。	发布批次1
BatchId	long	发布批次 ID。	1371
BatchNo	integer	分批发布时当前批次号。	2147483647
BatchTotal	integer	批次发布总批次数。	3
BatchInterval	integer	本批次发布完成之后间隔多长时间发布下一批次，单位：小时。	12
BatchProcess	integer	当前批次的发布进度，已发布多少台机器。	12
Status	integer	客户端发布状态。取值： 0：未开始 1：发布中 2：发布完成 3：发布暂停 4：强制升级中	1
OperationBase	integer	资产选择维度。取值： 0：机器实例 1：机器分组 2：VPC 实例 ID	0

示例

正常返回示例

JSON格式

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25
  },
  "BatchList": [
    {
      "Version": "0.0.9",
      "BatchName": "发布批次1",
      "BatchId": 1371,
      "BatchNo": 2147483647,
      "BatchTotal": 3,
      "BatchInterval": 12,
      "BatchProcess": 12,
      "Status": 1,
      "OperationBase": 0
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

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