# 开启实例无锁变更任务 - StartOnlineDDLTask #### 功能介绍 开启实例无锁变更任务。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:database:modify | Permission_management | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:database:modify | - | #### URI POST /v3/{project_id}/instances/{instance_id}/online-ddl-task 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | | Content-Type | 是 | String | **参数解释**： 内容类型。 **约束限制**： 不涉及。 **取值范围**： application/json。 **默认值**： application/json。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | auto_clear | 否 | Boolean | **参数解释**： 是否开启自动清理临时表。 **约束限制**： 不涉及。 **取值范围**： - true：开启自动清理临时表。 - false：关闭自动清理临时表。 **默认取值**： false。 | | task_content | 是 | Array of [TaskContentItem] objects | **参数解释**： 无锁变更任务详细内容。 **约束限制**： 不涉及。 | 表4TaskContentItem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | schema | 是 | String | **参数解释**： 无锁变更的目标数据库。 获取方法请参见[查询数据库列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlDatabase.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ddl_info | 是 | Array of [DDLInfoItem] objects | **参数解释**： 无锁变更的DDL信息。 **约束限制**： 不涉及。 | 表5DDLInfoItem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sql | 是 | String | **参数解释**： 无锁变更的具体执行SQL。 **约束限制**: 满足ALTER TABLE Statement语法形式，多条SQL需要以英文分号隔开。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 工作流ID，开启实例无锁变更任务的工作流标识。 **取值范围**： 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 - 开启实例无锁变更任务。 ``` 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);" } ] } ] } ``` - 批量开启实例无锁变更任务。 ``` 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);" } ] } ] } ``` #### 响应示例 **状态码：200** ``` { "job_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] - 开启实例无锁变更任务。 ``` 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("")) .build(); StartOnlineDdlTaskRequest request = new StartOnlineDdlTaskRequest(); request.withInstanceId("{instance_id}"); StartOnlineDDLTaskRequestV3 body = new StartOnlineDDLTaskRequestV3(); List listTaskContentDdlInfo = new ArrayList<>(); listTaskContentDdlInfo.add( new StartOnlineDDLInfoItem() .withSql("Alter table test_tb add name varchar(11);") ); List 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()); } } } ``` - 批量开启实例无锁变更任务。 ``` 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("")) .build(); StartOnlineDdlTaskRequest request = new StartOnlineDdlTaskRequest(); request.withInstanceId("{instance_id}"); StartOnlineDDLTaskRequestV3 body = new StartOnlineDDLTaskRequestV3(); List 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 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()); } } } ``` - [Python] - 开启实例无锁变更任务。 ``` # 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("")) \ .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) ``` - 批量开启实例无锁变更任务。 ``` # 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("")) \ .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) ``` - [Go] - 开启实例无锁变更任务。 ``` 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("")). 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) } } ``` - 批量开启实例无锁变更任务。 ``` 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("")). 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=StartOnlineDDLTask)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。