Help Center/ Distributed Cache Service/ API Reference/ API V2/ Cache Analysis/ Listing Hot Key Analysis Tasks
Updated on 2025-05-13 GMT+08:00
View PDF

Listing Hot Key Analysis Tasks

Function

This API is used to query the list of hot key analysis tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey-tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

String

Parameter description:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Parameter description:

Offset, which is the position where the query starts.

Constraints:

N/A

Value range:

≥ 0

Default value:

0

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Value range:

1–1000

Default value:

10

status

No

String

Parameter description:

Status of the hot key analysis task.

Value range:

  • waiting: The task is to be processed.

  • running: The task is being processed.

  • success: The task is successful.

  • failed: The task fails.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A

count

Integer

Parameter description:

Number of times that hot keys are analyzed.

Value range:

N/A

records

Array of RecordsResponse objects

Parameter description:

List of hot key analysis record.

Value range:

N/A
Table 4 RecordsResponse

Parameter

Type

Description

id

String

Parameter description:

Task execution record ID. (This ID corresponds to parameters bigkey_id and hotkey_id in the APIs for querying big key or hot key analysis details.)

Value range:

N/A

status

String

Parameter description:

Status of the hot key analysis task.

Value range:

  • waiting: The task is to be processed.

  • running: The task is being processed.

  • success: The task is successful.

  • failed: The task fails.

scan_type

String

Parameter description:

Analysis method.

Value range:

  • manual: manual analysis.

  • auto: automatic analysis.

created_at

String

Parameter description:

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

Value range:

N/A

started_at

String

Parameter description:

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z.

Value range:

N/A

finished_at

String

Parameter description:

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z.

Value range:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error information.

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 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error information.

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 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error information.

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 8 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error information.

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 9 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error information.

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

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-tasks

Example Responses

Status code: 200

Hot key analysis tasks listed successfully.

{
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "count" : 1,
  "records" : [ {
    "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
    "scan_type" : "manual",
    "status" : "success",
    "created_at" : "2020-06-15T02:21:18.669Z",
    "started_at" : "2020-06-15T02:21:23.534Z",
    "finished_at" : "2020-06-15T02:21:25.588Z"
  } ]
}

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4922",
  "error_msg" : "Does not support hotkey analyze."
}

Status Codes

Status Code

Description

200

Hot key analysis tasks listed successfully.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Cache Analysis