Querying Hot Key Analysis Details
Function
This API is used to query the hot key analysis details.
URI
GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}
|
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 |
|
hotkey_id |
Yes |
String |
Definition: ID of the hot key analysis task. The ID can be obtained by calling the Listing Hot Key Analysis Tasks API. Constraints: N/A Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Parameter description: ID of the hot key analysis task. Value range: N/A |
|
instance_id |
String |
Parameter description: Instance ID. Value range: N/A |
|
status |
String |
Parameter description: Status of the hot key analysis task. Value range:
|
|
scan_type |
String |
Parameter description: Analysis method. Value range:
|
|
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. (The value is null and is not returned when the analysis task is being created.) Value range: N/A |
|
finished_at |
String |
Parameter description: Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.) Value range: N/A |
|
num |
Integer |
Parameter description: Number of hot keys. Value range: N/A |
|
keys |
Array of HotkeysBody objects |
Parameter description: Hot key record. (The value is null and is not returned when the analysis task is being created.) Value range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Parameter description: Key name. Value range: N/A |
|
type |
String |
Definition: Key type. Range:
|
|
shard |
String |
Parameter description: Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is ip:port. Value range: N/A |
|
db |
Integer |
Parameter description: Database where a hot key is located. Value range: 0–255 |
|
size |
Long |
Parameter description: Size of the key value. Value range: N/A |
|
unit |
String |
Parameter description: Key unit. Value range:
|
|
freq |
Integer |
Parameter description: Reflects the access frequency of a key within a specific period of time. The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed. Value range: N/A |
Status code: 400
|
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
|
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
|
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
|
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
|
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-task/0ccb25d5-27cf-4188-b5ea-987730a85371
Example Responses
Status code: 200
Hot key analysis details queried successfully.
{
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"status" : "success",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z",
"started_at" : "2020-06-15T02:21:23.534Z",
"finished_at" : "2020-06-15T02:21:25.588Z",
"keys" : [ {
"name" : "dcs-hotkey-test",
"type" : "string",
"shard" : "192.168.1.134:6379",
"db" : 0,
"size" : 3000,
"unit" : "byte",
"freq" : 4
} ]
}
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 details queried 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.
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