Listing Big Key Analysis Tasks

Function

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

URI

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

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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of items displayed on each page.

status

No

String

Analysis task status.

Enumeration values:

  • waiting

  • running

  • success

  • failed

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID.

count

Integer

Number of times that big keys are analyzed.

records

Array of RecordsResponse objects

List of big key analysis record.

Table 4 RecordsResponse

Parameter

Type

Description

id

String

Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.)

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.

finished_at

String

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

Status code: 400

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: 401

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: 403

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

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

Status code: 500

Table 9 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

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

Example Responses

Status code: 200

Big key analysis records queried 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.4919",
  "error_msg" : "Does not support bigkey analyze."
}

Status Codes

Status Code

Description

200

Big key analysis records 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.