ListPublishBatch API Reference for Agent Upgrade Batches - Security Center

Query the details of a release batch for upgrade.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListPublishBatch

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UpgradeVersion	string	Yes	The destination version of the Security Center agent.	0.0.9
CurrentPage	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	20
BatchName	string	No	The name of the release batch.	Batch 1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1
PageInfo	object	The page information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	25
BatchList	array<object>	The information about the release batches.
	object	The information about the release batch.
Version	string	The destination version of the Security Center agent.	0.0.9
BatchName	string	The name of the release batch.	Release Batch 1
BatchId	integer	The ID of the release batch.	1371
BatchNo	integer	The current batch number during a batch release.	2147483647
BatchTotal	integer	The total number of batches.	3
BatchInterval	integer	The interval between two release batches. Unit: hours.	12
BatchProcess	integer	The progress of the release batch. This parameter indicates the number of servers that are upgraded in the release batch.	12
Status	integer	The publish status of the Security Center agent. Valid values: 0: not started. 1: publishing. 2: published. 3: publish suspended. 4: forcibly upgrading.	1
OperationBase	integer	The asset selection dimension. Valid values: 0: instance. 1: machine group. 2: Virtual Private Cloud (VPC) ID.	0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.