Querying Big Key Analysis Details

Function

This API is used to query the big key analysis details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}

**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
bigkey_id	Yes	String	Parameter description: ID of the big key analysis task. The ID can be obtained by calling the Listing Big Key Analysis Tasks API. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	Parameter description: ID of the big 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 big 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. (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 big keys. Value range: N/A
keys	Array of BigkeysBody objects	Parameter description: Big key record. (The value is null and is not returned when the analysis task is being created.) Value range: N/A

**Table 3** BigkeysBody
Parameter	Type	Description
name	String	Parameter description: Key name. Value range: N/A
type	String	Parameter description: Key type. Value range: string list set zset hash
shard	String	Parameter description: Shard where the big key is located. This parameter is available only when the instance type is cluster. The format is ip:port. Value range: N/A
db	Integer	Parameter description: Database where a big 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: count: number of keys. byte: key size.

Status code: 400

**Table 4** 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 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: 403

**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: 404

**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: 500

**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

Example Requests

GET https://{dcs_endpoint}/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.