Updated on 2023-11-24 GMT+08:00

Viewing Parameter Change History

API Description

This API is used to view the parameter change history.

Restrictions

Only the parameter change history of the last seven days can be viewed.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/histories

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/341bc383a3e24221a94c4ad0b4547e8apr02/histories?offset=0&limit=10

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

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

project_id

string

path

Yes

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

Table 2 Path parameters

Name

Mandatory

Type

Description

config_id

Yes

String

Parameter template ID.

Table 3 Query parameters

Name

Mandatory

Type

Description

offset

No

Integer

Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value must be a positive number.

limit

No

Integer

The upper limit of the number of queried records.

  • The value ranges from 1 to 100.
  • If this parameter is not transferred, the first 100 records are queried by default.

Requests

None

Responses

  • Parameter description
    Table 4 Response body parameters

    Name

    Type

    Description

    histories

    Array of Table 5-5 objects

    Change history of the parameter template.

    Table 5 HistoryInfo

    Name

    Type

    Description

    parameter_name

    String

    Parameter name.

    old_value

    String

    Value before modification.

    new_value

    String

    New value.

    updated_at

    String

    Modification time. The format is "yyyy-MM-ddTHH:mm:ssZ". T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

  • Example response
    { 
      "histories" : [ { 
        "parameter_name" : "rateLimit.mbps", 
        "old_value" : "500", 
        "new_value" : "350", 
        "updated_at" : "2022-06-07T09:25:45+0000" 
      } ] 
    }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.