Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Moving a TMLog File
Updated on 2026-05-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Moving a TMLog File

Function

This API is used to move a TMLog file.

Compress and move a TMLog file to a backup directory.

Constraints

None

API Calling

For details, see Calling APIs.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    ddm:instance:moveTmlogs

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    ddm:instance:modify

    -

URI

POST /v3/{project_id}/instances/{instance_id}/tmlogs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 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 contains 36 characters with a suffix of in09. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

node_ids

Yes

Array of strings

Node ID list.

Example Request

Moving a TMLog file

POST https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/instances/b7eabbbc6bxxxxxxxxxxadfffa99a7c2in09/tmlogs

{
  "node_ids" : [ "d768e14643xxxxxxxxxxxxxx692dcfa5no09", "3422de7fc5xxxxxxxxxxxxxxd9a7f675no09" ]
}

Response Parameters

  • Normal response
Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Job ID.

Example Response

  • Normal response example 
    {
  "job_id" : "24xxxx04-xxxx-xxxx-xxxx-c65xxxx857c9"
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances