清理实例无锁变更任务临时表 - ClearOnlineDDLTaskTempTable
功能介绍
清理实例无锁变更任务产生的临时表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/{project_id}/instances/{instance_id}/online-ddl-task/clear
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
| Content-Type | 是 | String | 参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认值: application/json。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_id | 是 | String | 参数解释: 无锁变更任务唯一标识。 获取方法参见查询无锁变更任务记录列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| task_content | 是 | Array of TaskContentItem objects | 参数解释: 无锁变更任务详细内容,包含目标数据库和临时表名。 约束限制: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| schema | 是 | String | 参数解释: 无锁变更的目标数据库。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| ddl_info | 是 | Array of DDLInfoItem objects | 参数解释: 无锁变更的DDL信息,包含临时表名。 约束限制: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| table | 是 | String | 参数解释: 无锁变更产生的临时表,获取方法参见查询无锁变更任务记录列表的响应参数temp_table_name。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 任务流ID,清理实例无锁变更任务临时表的工作流标识。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
清理实例无锁变更任务产生的临时表。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/online-ddl-task/clear
{
"task_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b",
"task_content" : [ {
"schema" : "testdb",
"ddl_info" : [ {
"table" : "~test_tb_20250402111436_del"
} ]
} ]
} 响应示例
状态码:200
Success.
{
"job_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b"
} SDK代码示例
SDK代码示例如下。
清理实例无锁变更任务产生的临时表。
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 ClearOnlineDdlTaskTempTableSolution { 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(); ClearOnlineDdlTaskTempTableRequest request = new ClearOnlineDdlTaskTempTableRequest(); request.withInstanceId("{instance_id}"); ClearOnlineDDLTaskTempTableRequestV3 body = new ClearOnlineDDLTaskTempTableRequestV3(); List<DDLInfoItem> listTaskContentDdlInfo = new ArrayList<>(); listTaskContentDdlInfo.add( new DDLInfoItem() .withTable("~test_tb_20250402111436_del") ); List<TaskContentItem> listbodyTaskContent = new ArrayList<>(); listbodyTaskContent.add( new TaskContentItem() .withSchema("testdb") .withDdlInfo(listTaskContentDdlInfo) ); body.withTaskContent(listbodyTaskContent); body.withTaskId("42371a73-a6ec-43e4-89d6-540f492f7e7b"); request.withBody(body); try { ClearOnlineDdlTaskTempTableResponse response = client.clearOnlineDdlTaskTempTable(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()); } } } |
清理实例无锁变更任务产生的临时表。
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 = ClearOnlineDdlTaskTempTableRequest() request.instance_id = "{instance_id}" listDdlInfoTaskContent = [ DDLInfoItem( table="~test_tb_20250402111436_del" ) ] listTaskContentbody = [ TaskContentItem( schema="testdb", ddl_info=listDdlInfoTaskContent ) ] request.body = ClearOnlineDDLTaskTempTableRequestV3( task_content=listTaskContentbody, task_id="42371a73-a6ec-43e4-89d6-540f492f7e7b" ) response = client.clear_online_ddl_task_temp_table(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
清理实例无锁变更任务产生的临时表。
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 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.ClearOnlineDdlTaskTempTableRequest{} request.InstanceId = "{instance_id}" var listDdlInfoTaskContent = []model.DdlInfoItem{ { Table: "~test_tb_20250402111436_del", }, } var listTaskContentbody = []model.TaskContentItem{ { Schema: "testdb", DdlInfo: listDdlInfoTaskContent, }, } request.Body = &model.ClearOnlineDdlTaskTempTableRequestV3{ TaskContent: listTaskContentbody, TaskId: "42371a73-a6ec-43e4-89d6-540f492f7e7b", } response, err := client.ClearOnlineDdlTaskTempTable(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success. |
| 400 | Client error. |
| 500 | Server error. |
错误码
请参见错误码。