Viewing Application Records of a Parameter Template
Function
This API is used to view application records of a parameter template.
Constraints
This API supports the following instance types:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx instance with classic storage
- GeminiDB Redis instance with classic storage
After an instance is deleted, application records of the parameter template that the instance uses are also deleted.
URI
GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
config_id |
Yes |
String |
Explanation: Parameter group ID Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Explanation: Index offset Constraints: The value can contain only digits. Values: The value cannot be a negative number. Default value: If offset is set to N, the query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data. |
limit |
No |
Integer |
Explanation: Maximum records to be queried Constraints: N/A Values: 1 to 100 Default value: If this parameter is not transferred, the first 100 records are queried by default. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token Constraints: N/A Values: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
histories |
Array of ApplyHistoryRsp objects |
Explanation: Application records of the parameter template Values: N/A |
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Explanation: Instance ID Values: N/A |
instance_name |
String |
Explanation: Instance name Values: N/A |
applied_at |
String |
Explanation: Effective time in the yyyy-MM-ddTHH:mm:ssZ format. Values: T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. |
apply_result |
String |
Explanation: Application result Values:
|
failure_reason |
String |
Explanation: Failure cause Values: N/A |
Example Request
- URI example
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/056f86e8d480d3cb2f43c00183f75e1f/configurations/e02e76567ae04662a2753492b77f965bpr06/applied-histories?offset=0&limit=10
Example Response
Status code: 200
Success
{ "histories" : [ { "instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06", "instance_name" : "test", "applied_at" : "2022-09-20T11:17:04+0000", "apply_result" : "SUCCESS", "failure_reason": "" } ] }
Status Codes
For details, see Status Codes.
Error Codes
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot