Creating a Big Key Analysis Task

Function

This API is used to create a big key analysis task for a DCS Redis instance.

URI

POST /v2/{project_id}/instances/{instance_id}/bigkey-task

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.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Big key analysis record ID.

instance_id

String

Instance ID.

status

String

Analysis task status.

Enumeration values:

  • waiting

  • running

  • success

  • failed

scan_type

String

Analysis method.

Enumeration values:

  • manual

  • auto

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.)

Table 3 BigkeysBody

Parameter

Type

Description

name

String

Key name.

type

String

Key type.

Enumeration values:

  • string

  • list

  • set

  • zset

  • hash

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 a big key is located.

size

Long

Size of the key value.

unit

String

Key unit. count: number of keys; byte: key size.

Status code: 400

Table 4 Response body parameters

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

Table 5 Response body parameters

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

Table 6 Response body parameters

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

Table 7 Response body parameters

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

Table 8 Response body parameters

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

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

Example Responses

Status code: 200

Big key analysis task created successfully.

{
  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "status" : "waiting",
  "scan_type" : "manual",
  "created_at" : "2020-06-15T02:21:18.669Z",
  "num" : 0
}

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 task created 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.