Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Querying the Estimated Database Patch Upgrade Duration
Updated on 2025-08-22 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

  • URI example
    https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/{instance_id}/db-upgrade-duration
    Table 1 Request parameters

    Name

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    Definition

    User token obtained from IAM. For details, see Authentication.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    project_id

    Yes

    String

    Definition

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

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    String

    Definition

    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.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request Parameters

None

Response Parameters

  • Parameter description
    Table 2 Response body parameters

    Name

    Type

    Description

    strategies

    Array of Table 3 objects

    Definition

    Upgrade policy list.

    Range

    N/A

    Table 3 DurationStrategies

    Name

    Type

    Description

    strategy

    String

    Definition

    Upgrade policy.

    Range

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

    estimated_upgrade_duration

    Integer

    Definition

    Upgrade duration, in minutes.

    Range

    N/A

Example Request

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/{instance_id}/db-upgrade-duration

Example Response

Status code: 200

Success.

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