Updated on 2026-01-08 GMT+08:00

Querying the Estimated Database Patch Upgrade Duration

API Description

This API is used to query the estimated database patch upgrade duration.

URI

  • URI format
    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-upgrade-duration
    Table 1 Path parameters

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

    instance_id

    Yes

    String

    Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Table 3 Response body parameters

Name

Type

Description

strategies

Array of Table 3 objects

Upgrade policy list.

Table 4 DurationStrategies

Name

Type

Description

strategy

String

Upgrade policy.

  • minimized_interrupt_time: indicates the shortest interruption time.
  • minimized_upgrade_time: indicates the minimum upgrade duration.

estimated_upgrade_duration

Integer

Upgrade duration, in minutes.

  • Example response
    { 
      "strategies" : [ { 
        "strategy" : "minimized_interrupt_time", 
        "estimated_upgrade_duration" : 10 
      }, { 
        "strategy" : "minimized_upgrade_time", 
        "estimated_upgrade_duration" : 5 
      } ] 
    }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.