更新时间:2024-02-04 GMT+08:00
分享

迁移任务配置设置

功能介绍

配置迁移任务特殊设置,例如配置指定同步的文件或路径

调用方法

请参见如何调用API

URI

POST /v3/tasks/{task_id}/configuration-setting

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

任务id

最小长度:0

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

configurations

Array of ConfigBody objects

配置项列表

数组长度:0 - 10

表4 ConfigBody

参数

是否必选

参数类型

描述

config_key

String

配置类型,分为:”EXCLUDE_MIGRATE_PATH","SYNC_EXCLUDE_PATH","ONLY_SYNC_PATH"等

最小长度:0

最大长度:255

config_value

String

具体配置参数字段,保存于数据库,最终在agent端进行解析

最小长度:0

最大长度:1024

config_status

String

描述配置状态的保留字段

最小长度:0

最大长度:255

响应参数

状态码: 404

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

请求示例

配置迁移任务特殊设置,配置任务是LINUX_CPU_LIMIT,限制值是50。

POST https://{endpoint}/v3/tasks/{task_id}/configuration-setting

{
  "configurations" : [ {
    "config_key" : "LINUX_CPU_LIMIT",
    "config_value" : 50
  } ]
}

响应示例

SDK代码示例

SDK代码示例如下。

配置迁移任务特殊设置,配置任务是LINUX_CPU_LIMIT,限制值是50。

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;

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

public class UploadSpecialConfigurationSettingSolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        UploadSpecialConfigurationSettingRequest request = new UploadSpecialConfigurationSettingRequest();
        ConfigurationRequestBody body = new ConfigurationRequestBody();
        List<ConfigBody> listbodyConfigurations = new ArrayList<>();
        listbodyConfigurations.add(
            new ConfigBody()
                .withConfigKey("LINUX_CPU_LIMIT")
                .withConfigValue("50")
        );
        body.withConfigurations(listbodyConfigurations);
        request.withBody(body);
        try {
            UploadSpecialConfigurationSettingResponse response = client.uploadSpecialConfigurationSetting(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());
        }
    }
}

配置迁移任务特殊设置,配置任务是LINUX_CPU_LIMIT,限制值是50。

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = UploadSpecialConfigurationSettingRequest()
        listConfigurationsbody = [
            ConfigBody(
                config_key="LINUX_CPU_LIMIT",
                config_value="50"
            )
        ]
        request.body = ConfigurationRequestBody(
            configurations=listConfigurationsbody
        )
        response = client.upload_special_configuration_setting(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

配置迁移任务特殊设置,配置任务是LINUX_CPU_LIMIT,限制值是50。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UploadSpecialConfigurationSettingRequest{}
	var listConfigurationsbody = []model.ConfigBody{
        {
            ConfigKey: "LINUX_CPU_LIMIT",
            ConfigValue: "50",
        },
    }
	request.Body = &model.ConfigurationRequestBody{
		Configurations: listConfigurationsbody,
	}
	response, err := client.UploadSpecialConfigurationSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

上传相关配置成功

404

任务不存在

500

上传配置设置结果异常。

错误码

请参见错误码

分享:

    相关文档

    相关产品