Help Center/Distributed Cache Service/API Reference/API V2/Cache Analysis/Querying the Configurations of Automatic Hot Key Analysis
Updated on 2025-05-13 GMT+08:00
View PDF

Querying the Configurations of Automatic Hot Key Analysis

Function

This API is used to query configurations of automatic hot key analysis.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey/autoscan

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A

enable_auto_scan

Boolean

Parameter description:

Whether to enable scheduled cache analysis.

Value range:

  • true

  • false

schedule_at

Array of strings

Parameter description:

UTC time of the day that analysis is scheduled for. Example: 21:00.

Value range:

N/A

updated_at

String

Parameter description:

Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z.

Value range:

N/A

Status code: 400

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

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

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

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

Example Requests

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

Example Responses

Status code: 200

This API is used to query configurations of automatic hot key analysis.

{
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "enable_auto_scan" : true,
  "schedule_at" : [ "21:00" ],
  "updated_at" : "2020-06-17T02:42:40.793Z"
}

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4922",
  "error_msg" : "Does not support hotkey analyze."
}

Status Codes

Status Code

Description

200

This API is used to query configurations of automatic hot key analysis.

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.

Parent topic:Cache Analysis