DescribeServiceRollout-阿里云帮助中心

Retrieves the details of a service rollout.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The region ID where the service is deployed.	cn-shanghai
ServiceName	string	No	The name of the service.	foo

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID. This ID is unique to each request and is used for troubleshooting.	40325405-579C-4D82****
Rollout	object	Details of the service rollout, including the rollout strategy (`Strategy`) and execution status (`Status`).
Strategy	object	The rollout strategy configuration. This object contains the parameters for a canary release or batch release.
Partition	object	The configuration for a canary release. This object is returned only when the canary release strategy is used.
Partition	string	Specifies the number or percentage of old replicas to keep. For example, a value of `50%` indicates that 50% of the old replicas are retained.	50%
Batch	object	The configuration for a batch release. This object is returned only when the batch release strategy is used.
BatchSize	string	The number or percentage of replicas to update in each batch.	1
Interval	string	The time to wait between batches.	5m
Status	object	The current progress and phase of the rollout.
Phase	string	The current release phase. Valid values: `Pending`: The rollout is waiting to start. `Running`: The rollout is in progress. `Paused`: The rollout is paused. `Completed`: The rollout is complete. `Failed`: The rollout has failed.	Running
TotalReplicas	integer	The total number of desired replicas for the service.	10
UpdatedReplicas	integer	The number of replicas updated to the new revision.	5
CurrentRevision	string	The identifier for the currently running revision.	service-abc123-v1
UpdateRevision	string	The identifier for the target revision.	service-abc123-v2
NextBatchStartTime	string	The scheduled start time for the next batch.	2026/05/08 16:10:56

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.