Collecting Redis Run Logs

Function

This API is used to collect Redis run logs.

URI

POST /v2/{project_id}/instances/{instance_id}/redislog

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
query_time	No	Integer	Date offset, indicating that the query starts from the last n days. The default value is 0. Value range: 0, 1, 3, and 7. For example, the value 0 indicates that the logs of the current day are queried, and the value 7 indicates that the logs of the last seven days are queried.
log_type	Yes	String	Log type. Currently, only Redis run logs are supported. The value is run.
replication_id	No	String	Replica ID. You can query the replica ID from Shards and Replicas. This parameter is mandatory when the instance is not single-node.

Request Parameters

None

Response Parameters

Status code: 204

Run logs collected successfully.

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&query_time=7&replication_id=50fa23b4-74d3-4d5c-98b9-39188a1f2daf

Example Responses

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid logType."
}

Status Codes

Status Code	Description
204	Run logs collected successfully.
400	Invalid request.
401	Invalid authentication information.
403	The request is rejected.
404	The requested resource is not found.
500	Internal service error.