更新时间:2024-11-06 GMT+08:00
分享

修改自定义模板

功能介绍

修改自定义模板。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/config-templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

template_id

String

模板ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

模板名称。

description

String

模板的描述信息。

params

Map<String,String>

参数配置信息。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

result

String

修改自定义模板的结果,success表示成功,如果失败则会返回对应的报错信息。

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)

请求示例

PUT https://{dcs_endpoint}/v2/{project_id}/config-templates/{template_id}

{
  "name" : "Test",
  "description" : "Test",
  "params" : {
    "latency-monitor-threshold" : 15
  }
}

响应示例

状态码: 200

修改自定义模板成功。

{
  "result" : "success"
}

状态码: 400

非法请求。

{
  "error_code" : "111400063",
  "error_msg" : "Invalid {0} parameter in the request."
}

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
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;

import java.util.Map;
import java.util.HashMap;

public class UpdateConfigTemplateSolution {

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

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateConfigTemplateRequest request = new UpdateConfigTemplateRequest();
        request.withTemplateId("{template_id}");
        UpdateCustomTemplateBody body = new UpdateCustomTemplateBody();
        Map<String, String> listbodyParams = new HashMap<>();
        listbodyParams.put("latency-monitor-threshold", "15");
        body.withParams(listbodyParams);
        body.withDescription("Test");
        body.withName("Test");
        request.withBody(body);
        try {
            UpdateConfigTemplateResponse response = client.updateConfigTemplate(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 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 = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateConfigTemplateRequest()
        request.template_id = "{template_id}"
        listParamsbody = {
            "latency-monitor-threshold": "15"
        }
        request.body = UpdateCustomTemplateBody(
            params=listParamsbody,
            description="Test",
            name="Test"
        )
        response = client.update_config_template(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateConfigTemplateRequest{}
	request.TemplateId = "{template_id}"
	var listParamsbody = map[string]string{
        "latency-monitor-threshold": "15",
    }
	descriptionUpdateCustomTemplateBody:= "Test"
	nameUpdateCustomTemplateBody:= "Test"
	request.Body = &model.UpdateCustomTemplateBody{
		Params: listParamsbody,
		Description: &descriptionUpdateCustomTemplateBody,
		Name: &nameUpdateCustomTemplateBody,
	}
	response, err := client.UpdateConfigTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

修改自定义模板成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码

相关文档