Help Center/ TaurusDB/ API Reference/ APIs/ Lock-Free Change/ Enabling a Lock-Free Change Task for an Instance
Updated on 2026-09-14 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling a Lock-Free Change Task for an Instance

Function

This API is used to enable a lock-free change task for an instance. Before calling this API:

Calling Method

For details, see Calling APIs.

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 identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:database:modify

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:database:modify

    -

URI

POST /v3/{project_id}/instances/{instance_id}/online-ddl-task

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, 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.

To obtain this value, see Querying DB Instances.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. 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. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English

  • zh-cn: Chinese

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

auto_clear

No

Boolean

Definition

Whether to enable automatic temporary table cleanup.

Constraints

N/A

Range

  • true: Automatic temporary table cleanup is enabled.

  • false: Automatic temporary table cleanup is disabled.

Default Value

false

task_content

Yes

Array of TaskContentItem objects

Definition

Details about the lock-free change task.

Constraints

N/A
Table 4 TaskContentItem

Parameter

Mandatory

Type

Description

schema

Yes

String

Definition

Target database of the lock-free change.

To obtain this value, see Querying Databases.

Constraints

N/A

Range

N/A

Default Value

N/A

ddl_info

Yes

Array of DDLInfoItem objects

Definition

Lock-free change DDL.

Constraints

N/A
Table 5 DDLInfoItem

Parameter

Mandatory

Type

Description

sql

Yes

String

Definition

SQL statement to be executed for the lock-free change.

Constraints

The value must comply with the ALTER TABLE statement syntax. Separate multiple SQL statements with semicolons (;).

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

job_id

String

Definition

ID of the workflow for enabling the lock-free change task.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Enabling a lock-free change task for an instance

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/online-ddl-task

{
  "auto_clear" : true,
  "task_content" : [ {
    "schema" : "testdb",
    "ddl_info" : [ {
      "sql" : "Alter table test_tb add name varchar(11);"
    } ]
  } ]
}

  • Batch enabling lock-free change tasks for an instance

    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/online-ddl-task

{
  "auto_clear" : true,
  "task_content" : [ {
    "schema" : "testdb",
    "ddl_info" : [ {
      "sql" : "Alter table test_tb1 add name varchar(11); Alter table test_tb2 add age varchar(11);"
    } ]
  } ]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b"
}

SDK Sample Code

The SDK sample code is as follows.

  • Enabling a lock-free change task for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class StartOnlineDdlTaskSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        StartOnlineDdlTaskRequest request = new StartOnlineDdlTaskRequest();
        request.withInstanceId("{instance_id}");
        StartOnlineDDLTaskRequestV3 body = new StartOnlineDDLTaskRequestV3();
        List<StartOnlineDDLInfoItem> listTaskContentDdlInfo = new ArrayList<>();
        listTaskContentDdlInfo.add(
            new StartOnlineDDLInfoItem()
                .withSql("Alter table test_tb add name varchar(11);")
        );
        List<StartOnlineTaskContentItem> listbodyTaskContent = new ArrayList<>();
        listbodyTaskContent.add(
            new StartOnlineTaskContentItem()
                .withSchema("testdb")
                .withDdlInfo(listTaskContentDdlInfo)
        );
        body.withTaskContent(listbodyTaskContent);
        body.withAutoClear(true);
        request.withBody(body);
        try {
            StartOnlineDdlTaskResponse response = client.startOnlineDdlTask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • Batch enabling lock-free change tasks for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class StartOnlineDdlTaskSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        StartOnlineDdlTaskRequest request = new StartOnlineDdlTaskRequest();
        request.withInstanceId("{instance_id}");
        StartOnlineDDLTaskRequestV3 body = new StartOnlineDDLTaskRequestV3();
        List<StartOnlineDDLInfoItem> listTaskContentDdlInfo = new ArrayList<>();
        listTaskContentDdlInfo.add(
            new StartOnlineDDLInfoItem()
                .withSql("Alter table test_tb1 add name varchar(11); Alter table test_tb2 add age varchar(11);")
        );
        List<StartOnlineTaskContentItem> listbodyTaskContent = new ArrayList<>();
        listbodyTaskContent.add(
            new StartOnlineTaskContentItem()
                .withSchema("testdb")
                .withDdlInfo(listTaskContentDdlInfo)
        );
        body.withTaskContent(listbodyTaskContent);
        body.withAutoClear(true);
        request.withBody(body);
        try {
            StartOnlineDdlTaskResponse response = client.startOnlineDdlTask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • Enabling a lock-free change task for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = StartOnlineDdlTaskRequest()
        request.instance_id = "{instance_id}"
        listDdlInfoTaskContent = [
            StartOnlineDDLInfoItem(
                sql="Alter table test_tb add name varchar(11);"
            )
        ]
        listTaskContentbody = [
            StartOnlineTaskContentItem(
                schema="testdb",
                ddl_info=listDdlInfoTaskContent
            )
        ]
        request.body = StartOnlineDDLTaskRequestV3(
            task_content=listTaskContentbody,
            auto_clear=True
        )
        response = client.start_online_ddl_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • Batch enabling lock-free change tasks for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = StartOnlineDdlTaskRequest()
        request.instance_id = "{instance_id}"
        listDdlInfoTaskContent = [
            StartOnlineDDLInfoItem(
                sql="Alter table test_tb1 add name varchar(11); Alter table test_tb2 add age varchar(11);"
            )
        ]
        listTaskContentbody = [
            StartOnlineTaskContentItem(
                schema="testdb",
                ddl_info=listDdlInfoTaskContent
            )
        ]
        request.body = StartOnlineDDLTaskRequestV3(
            task_content=listTaskContentbody,
            auto_clear=True
        )
        response = client.start_online_ddl_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • Enabling a lock-free change task for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.StartOnlineDdlTaskRequest{}
	request.InstanceId = "{instance_id}"
	var listDdlInfoTaskContent = []model.StartOnlineDdlInfoItem{
        {
            Sql: "Alter table test_tb add name varchar(11);",
        },
    }
	var listTaskContentbody = []model.StartOnlineTaskContentItem{
        {
            Schema: "testdb",
            DdlInfo: listDdlInfoTaskContent,
        },
    }
	autoClearStartOnlineDdlTaskRequestV3:= true
	request.Body = &model.StartOnlineDdlTaskRequestV3{
		TaskContent: listTaskContentbody,
		AutoClear: &autoClearStartOnlineDdlTaskRequestV3,
	}
	response, err := client.StartOnlineDdlTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • Batch enabling lock-free change tasks for an instance

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.StartOnlineDdlTaskRequest{}
	request.InstanceId = "{instance_id}"
	var listDdlInfoTaskContent = []model.StartOnlineDdlInfoItem{
        {
            Sql: "Alter table test_tb1 add name varchar(11); Alter table test_tb2 add age varchar(11);",
        },
    }
	var listTaskContentbody = []model.StartOnlineTaskContentItem{
        {
            Schema: "testdb",
            DdlInfo: listDdlInfoTaskContent,
        },
    }
	autoClearStartOnlineDdlTaskRequestV3:= true
	request.Body = &model.StartOnlineDdlTaskRequestV3{
		TaskContent: listTaskContentbody,
		AutoClear: &autoClearStartOnlineDdlTaskRequestV3,
	}
	response, err := client.StartOnlineDdlTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Lock-Free Change