All Products
Search
Document Center

Security Center:ListPublishBatch

Last Updated:Oct 24, 2025

Query the details of a release batch for upgrade.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListPublishBatchlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UpgradeVersionstringYes

The destination version of the Security Center agent.

0.0.9
CurrentPageintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page.

20
BatchNamestringNo

The name of the release batch.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1
PageInfoobject

The page information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

25
BatchListarray<object>

The information about the release batches.

BatchListobject

The information about the release batch.

Versionstring

The destination version of the Security Center agent.

0.0.9
BatchNamestring

The name of the release batch.

test
BatchIdlong

The ID of the release batch.

1371
BatchNointeger

The current batch number during a batch release.

2147483647
BatchTotalinteger

The total number of batches.

3
BatchIntervalinteger

The interval between two release batches. Unit: hours.

12
BatchProcessinteger

The progress of the release batch. This parameter indicates the number of servers that are upgraded in the release batch.

12
Statusinteger

The publish status of the Security Center agent. Valid values:

  • 0: not started.
  • 1: publishing.
  • 2: published.
  • 3: publish suspended.
  • 4: forcibly upgrading.
1
OperationBaseinteger

The asset selection dimension. Valid values:

  • 0: instance.
  • 1: machine group.
  • 2: Virtual Private Cloud (VPC) ID.
0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.