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.
|
Parameter |
Type |
IN |
Mandatory |
Description |
|---|---|---|---|---|
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
config_id |
Yes |
String |
Parameter template ID. |
|
Parameter |
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 |
Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100. |
Request Parameters
|
Parameter |
Type |
IN |
Mandatory |
Description |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
Yes |
User token |
Response Parameters
|
Name |
Type |
Description |
|---|---|---|
|
histories |
Array of Table 5-5 objects |
Application records of a parameter template. |
|
Name |
Type |
Description |
|---|---|---|
|
instance_id |
String |
DB instance ID. |
|
instance_name |
String |
DB instance name. |
|
applied_at |
String |
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. |
|
apply_result |
String |
Application result. SUCCESS indicates that the application of the parameter template is successful. FAILED indicates that the application fails. APPLYING indicates that the application is in progress. |
|
failure_reason |
String |
Failure cause. |
- Example response
{
"histories" : [ {
"instance_id" : "1967d9d9d6ef4c5ea38bd5a754f5737ein02",
"instance_name" : "dds-4525",
"applied_at" : "2022-06-07T09:25:45+0000",
"apply_result" : "SUCCESS"
} ]
}
Status Code
For details, see Status Code.
Error Code
For details, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot