Viewing Application Records of a Parameter Template

API Description

This API is used to view application records of a parameter template.

Restrictions

After an instance is deleted, application records of the parameter template that the instance uses are also deleted.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/applied-histories?offset=0&limit=10

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A
project_id	string	path	Yes	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

**Table 2** Path parameters
Name	Mandatory	Type	Description
config_id	Yes	String	Definition Parameter template ID. Constraints N/A Range N/A Default Value N/A

**Table 3** Query parameters
Name	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. Constraints The value must be an integer. Range The value cannot be a negative number. Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Number of records to be queried. Constraints The value must be a positive integer. Range 1 to 100 Default Value 100

Request Parameters

None

Response Parameters

Parameter description

**Table 4** Response body parameters
Name	Type	Description
histories	Array of Table 5-5 objects	Definition Application records of a parameter template. Range N/A

**Table 5** ApplicableInstancesInfo
Name	Type	Description
instance_id	String	Definition DB instance ID. Range N/A
instance_name	String	Definition DB instance name. Range N/A
applied_at	String	Definition Application 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. Range N/A
apply_result	String	Definition Application result. Range SUCCESS: The parameter template is applied to the corresponding instance. FAILED: The parameter template failed to be applied to the corresponding instance. APPLYING: The parameter template is being applied to the corresponding instance.
failure_reason	String	Definition Failure cause. Range N/A

Example response

{ 
  "histories" : [ { 
    "instance_id" : "1967d9d9d6ef4c5ea38bd5a754f5737ein02", 
    "instance_name" : "dds-4525",
    "applied_at" : "2022-06-07T09:25:45+0000", 
    "apply_result" : "SUCCESS" 
  } ] 
}

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.