Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Querying Index Usage Statistics
Updated on 2026-08-25 GMT+08:00

Querying Index Usage Statistics

Function

This API is used to query index usage statistics.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

GET /v3/{project_id}/instances/{instance_id}/index-usage/get-index-usage-statistics

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

collect_time

Long

Definition

Collection time (ms).

Range

N/A

total_index_usage_count

Long

Definition

Total index usage count.

Range

N/A

index_size_mb

Double

Definition

Total space occupied by indexes (MB).

Range

N/A

fragmentation_gl30_count

Long

Definition

Number of indexes whose fragmentation rate is greater than 30%.

Range

N/A

key_lookup_lt100_count

Long

Definition

Number of indexes whose lookup count is less than 100.

Range

N/A

Example Requests

GET https://das.cn-north-1.myhuaweicloud.com/v3/2cfb7eecd30f497f8e21f03106c7a604/instances/5eb0301017874d4b8d8e697ab8e5857ain04/index-usage/get-index-usage-statistics 
 

Example Responses

Status code: 200

Success.

{
    "collect_time": 1764204246000,
    "total_index_usage_count": 318,
    "index_size_mb": 10934.45,
    "fragmentation_gl30_count": 148,
    "key_lookup_lt100_count": 0
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.