Querying Big Key Analysis Details
Function
This API is used to query the big key analysis details.
URI
GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
bigkey_id |
Yes |
String |
ID of the big key analysis task. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Big key analysis record ID. |
instance_id |
String |
Instance ID. |
status |
String |
Analysis task status. Enumeration values:
|
scan_type |
String |
Analysis mode. Enumeration values:
|
created_at |
String |
Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". |
started_at |
String |
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.) |
finished_at |
String |
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.) |
num |
Integer |
Number of big keys. |
keys |
Array of BigkeysBody objects |
Big key record. (The value is null and is not returned when the analysis task is being created.) |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Key name. |
type |
String |
Key type. Enumeration values:
|
shard |
String |
Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is ip:port. |
db |
Integer |
Database where the big key is located. |
size |
Integer |
Size of the key value. |
unit |
String |
Unit of the key size. When the key type is string, the unit is byte. When the key type is list, set, zset, or hash, the unit is count. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Example Requests
GET https://dcs.cn-south-1.myhuaweicloud.com/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e
Example Responses
Status code: 200
Big 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-bigkey-test", "type" : "string", "shard" : "192.168.1.134:6379", "db" : 0, "size" : 3000, "unit" : "byte" } ] }
Status code: 400
Invalid request.
{ "error_code" : "DCS.4919", "error_msg" : "Does not support bigkey analyze." }
Status Codes
Status Code |
Description |
---|---|
200 |
Big 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.