Getting Information About a Volume Update Task

You can get information about the states of one or more volume update tasks.

This action enables you to track the progress and status of volume modifications, such as changes in volume size, IOPS, or volume type. For more information, see Modifying a Volume.

It also provides details about the volume’s configuration before and after the update.

Getting Information About a Volume Update Task Using OSC CLI

The ReadVolumeUpdateTasks command lists one or more specified tasks of volume update.

Request sample: Read a specific volume update task

$ osc-cli api ReadVolumeUpdateTasks --profile "default" \
    --Filters '{
        "TaskIds": ["vol-update-12345678"]
      }'

This command contains the following attributes that you need to specify:

DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
Filters: (optional) One or more filters.
- TaskIds: (optional) The IDs of the volume update tasks.
NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.
ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadVolumeUpdateTasks command returns the following elements:

NextPageToken: The token to request the next page of results. Each token refers to a specific page.
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.
VolumeUpdateTasks: Information about one or more volume update tasks.
- Comment: If the update volume task fails, an error message appears.
  Example: Update of volume vol-12345678.
- CompletionDate: The date at which the volume update task was marked as completed.
- Progress: The progress of the volume update task, as a percentage.
  Example: 100.
- StartDate: The creation date of the volume update task.
- State: The state of the volume (pending | active | completed | failed | canceled).
  Example: completed.
- Tags: One or more tags associated with the volume update task.
  - Key: The key of the tag, with a minimum of 1 character.
  - Value: The value of the tag, between 0 and 255 characters.
- TaskId: The ID of the volume update task in progress. Otherwise, it is not returned.
  Example: vol-update-12345678.
- VolumeId: The ID of the updated volume.
  Example: vol-12345678.
- VolumeUpdate: Information about the update of a volume.
  - Origin: Information about the parameters of the update of a volume.
    
    Iops: The new number of I/O operations per second (IOPS):
    
    For io1 volumes, the number of provisioned IOPS.
    
    For gp2 volumes, the baseline performance of the volume.
    Example: 200.
    
    Size: The new size of the volume, in gibibytes (GiB).
    Example: 50.
    
    VolumeType: The type of the volume (standard | io1 | gp2).
    Example: io1.
  - Target: Information about the parameters of the update of a volume.
    
    Iops: The new number of I/O operations per second (IOPS):
    
    For io1 volumes, the number of provisioned IOPS.
    
    For gp2 volumes, the baseline performance of the volume.
    Example: 200.
    
    Size: The new size of the volume, in gibibytes (GiB).
    Example: 50.
    
    VolumeType: The type of the volume (standard | io1 | gp2).
    Example: io1.

Result sample: Read a specific volume update task

{
  "VolumeUpdateTasks": [
    {
      "VolumeUpdate": {
        "Target": {
          "Iops": 200,
          "Size": 50,
          "VolumeType": "io1"
        },
        "Origin": {
          "Iops": 100,
          "Size": 25,
          "VolumeType": "standard"
        }
      },
      "Tags": [],
      "TaskId": "vol-update-12345678",
      "Comment": "Update of volume vol-12345678",
      "VolumeId": "vol-12345678",
      "State": "completed",
      "Progress": 100
    }
  ],
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}