更新时间:2024-06-28 GMT+08:00

修改主机集群

功能介绍

根据主机集群id修改主机集群信息。该接口于2024年9月30日后不再维护。

调用方法

请参见如何调用API

URI

PUT /v2/host-groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

主机集群id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json

缺省值:application/json;charset=utf-8

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

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

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

主机集群名

最小长度:3

最大长度:128

description

String

描述

最小长度:0

最大长度:500

slave_cluster_id

String

自定义slave资源池id

auto_connection_test_switch

Integer

自动测试功能已下架,该字段已失效

枚举值:

  • 0

  • 1

  • 2

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

group_id

String

主机集群id

请求示例

修改目标主机集群基本信息,信息包含主机集群名称、描述等。

https://{endpoint}/v2/host-groups/f3938bd63e354d2bb9d9cf7b5dc3bf95

{
  "name" : "test123",
  "description" : "这是一条描述信息",
  "slave_cluster_id" : "",
  "auto_connection_test_switch" : 0
}

响应示例

状态码: 200

OK 请求响应成功

{
  "group_id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95"
}

SDK代码示例

SDK代码示例如下。

Java

修改目标主机集群基本信息,信息包含主机集群名称、描述等。

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


public class UpdateDeploymentGroupSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateDeploymentGroupRequest request = new UpdateDeploymentGroupRequest();
        DeploymentGroupUpdateRequest body = new DeploymentGroupUpdateRequest();
        body.withAutoConnectionTestSwitch(DeploymentGroupUpdateRequest.AutoConnectionTestSwitchEnum.NUMBER_0);
        body.withSlaveClusterId("");
        body.withDescription("这是一条描述信息");
        body.withName("test123");
        request.withBody(body);
        try {
            UpdateDeploymentGroupResponse response = client.updateDeploymentGroup(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

修改目标主机集群基本信息,信息包含主机集群名称、描述等。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = UpdateDeploymentGroupRequest()
        request.body = DeploymentGroupUpdateRequest(
            auto_connection_test_switch=0,
            slave_cluster_id="",
            description="这是一条描述信息",
            name="test123"
        )
        response = client.update_deployment_group(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

修改目标主机集群基本信息,信息包含主机集群名称、描述等。

 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/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/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")

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

    client := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateDeploymentGroupRequest{}
	autoConnectionTestSwitchDeploymentGroupUpdateRequest:= model.GetDeploymentGroupUpdateRequestAutoConnectionTestSwitchEnum().E_0
	slaveClusterIdDeploymentGroupUpdateRequest:= ""
	descriptionDeploymentGroupUpdateRequest:= "这是一条描述信息"
	request.Body = &model.DeploymentGroupUpdateRequest{
		AutoConnectionTestSwitch: &autoConnectionTestSwitchDeploymentGroupUpdateRequest,
		SlaveClusterId: &slaveClusterIdDeploymentGroupUpdateRequest,
		Description: &descriptionDeploymentGroupUpdateRequest,
		Name: "test123",
	}
	response, err := client.UpdateDeploymentGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码