Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Creating a Task for Exporting Index Usage
Updated on 2026-08-25 GMT+08:00
View PDF
Share

Creating a Task for Exporting Index Usage

Function

This API is used to create a task for exporting index usage.

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:clouddba:write

    write

    -

    -

    -

    -

URI

POST /v3/{project_id}/instances/{instance_id}/index-usage/create-index-usage-export-task

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

export_type

Yes

String

Definition

Export type.

Constraints

N/A

Range

  • missingindex: Export table data.
  • missingindexscript: Export scripts.

Default Value

N/A

collect_time

Yes

Long

Definition

Collection time.

Constraints

N/A

Range

N/A

Default Value

N/A

bucket_name

Yes

String

Definition

Bucket name.

Constraints

N/A

Range

N/A

Default Value

N/A

conditions

Yes

Array of objects in Table 3

Definition

Filter criteria.

Constraints

N/A

Range

N/A

Default Value

N/A

object_name

Yes

String

Definition

Table name.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_field

No

String

Definition

Sorting field.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_asc

No

Boolean

Definition

Whether to sort in ascending order.

Constraints

N/A

Range

N/A

Default Value

N/A

cur_page

No

Integer

Definition

Current page.

Constraints

N/A

Range

N/A

Default Value

N/A

per_page

No

Integer

Definition

Page size.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Condition

Parameter

Mandatory

Type

Description

field

No

String

Definition

Filter field.

Constraints

N/A

Range

N/A

Default Value

N/A

min_value

No

Number

Definition

Minimum value.

Constraints

N/A

Range

N/A

Default Value

N/A

max_value

No

Number

Definition

Maximum value.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

Long

Definition

Task ID.

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/index-usage/create-index-usage-export-task 
 
{
    "bucket_name": "5257",
    "export_type": "missingindexscript",
    "start_time": 1764145334687,
    "end_time": 1764148934687,
    "sort_field": ""
}

Example Responses

Status code: 200

Success.

{
    "task_id": 3402
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Intelligent O&M