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 instances:

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.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:configuration:listAppliedHistory	List	-	-	nosql:param:list	-

URI

GET /v3/{project_id}/configurations/{config_id}/applied-histories

**Table 1** URI parameters
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 N/A Default Value N/A
config_id	Yes	String	Definition Parameter group ID Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset Constraints N/A Range The value must be a non-negative number. Default Value If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1 to 100 Default Value If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
histories	Array of ApplyHistoryRsp objects	Definition Application records of the parameter template Range N/A
total_count	Integer	Definition Total number of records Range N/A

**Table 5** ApplyHistoryRsp
Parameter	Type	Description
instance_id	String	Definition Instance ID Range N/A
instance_name	String	Definition Instance name Range N/A
applied_at	String	Definition Effective time in the yyyy-MM-ddTHH:mm:ssZ format. Range T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.
apply_result	String	Definition Application result Range SUCCESS: indicates that the parameter template is applied to the corresponding instance. APPLYING: indicates that the parameter template is being applied to the corresponding instance. FAILED: indicates that the parameter template fails to be applied to the corresponding instance.
failure_reason	String	Definition Failure cause Range N/A

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/056f86e8d480d3cb2f43c00183f75e1f/configurations/e02e76567ae04662a2753492b77f965bpr06/applied-histories?offset=0&limit=10

Example Responses

Status code: 200

Successful response

{
  
  "histories" : [
    {
      "instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06",
      "instance_name" : "test",
      "applied_at" : "2022-09-20T11:17:04+0000",
      "apply_result" : "SUCCESS",
      "failure_reason": ""
    }
  ]
}