Querying Application Records of a Parameter Template
Function
This API is used to query application records of a parameter template. Before calling this API:
- Learn how to authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/configurations/{config_id}/apply-history
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
| config_id | Yes | String | Definition Parameter template ID. Constraints It must be the ID of the parameter template corresponding to the instance. Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. To obtain this value, see Querying Details of a DB Instance. After the request is processed, this parameter value is the value of configuration_id in the response body. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Definition Number of records to be queried. Constraints The value cannot be a negative number. Range 1–100 Default Value 100 |
| offset | No | Integer | Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value cannot be a negative number. Range ≥ 0 Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
| X-Language | No | String | Definition Request language type. Constraints N/A Range Default Value en-us |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_count | String | Definition Number of application records of a parameter template. Range N/A |
| histories | Array of TemplateApplyHistory objects | Definition Application record information of a parameter template. |
| Parameter | Type | Description |
|---|---|---|
| target_id | String | Definition ID of the instance that the template is applied to. Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. |
| target_name | String | Definition Name of the instance that the template is applied to. Range Instance name corresponding to the instance ID |
| apply_result | String | Definition Application results. Range |
| applied_at | Number | Definition Time when the template was applied. Range N/A |
| error_code | String | Definition Error code. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Request
Querying application records of a parameter template
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/b366363c95b04b0eac39e73ea2672ffepr07/apply-history Example Response
Status code: 200
Success.
{
"total_count" : 1,
"histories" : [ {
"target_id" : "06789bdfbe414d78b9cef1b79d7d9680in07",
"target_name" : "gauss-11",
"apply_result" : "SUCCESS",
"applied_at" : 1712246191000,
"error_code" : ""
} ]
} Status Code
| Status Code | Description |
|---|---|
| 200 | Success. |
| 400 | Client error. |
| 500 | Server error. |
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
