文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 主机集群管理/ 新建主机集群 (推荐)
更新时间:2024-09-12 GMT+08:00

新建主机集群 (推荐)

功能介绍

在项目下新建主机集群。

调用方法

请参见如何调用API

URI

POST /v1/resources/host-groups

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)

X-Auth-Token

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

主机集群名称。

约束限制

不涉及。

取值范围

只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。

默认取值

不涉及。

project_id

String

参数解释

项目id,获取方式请参见获取项目id

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

os

String

参数解释

主机集群的操作系统类型。

约束限制

不涉及。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

默认取值

不涉及。

slave_cluster_id

String

参数解释

slave集群id,默认为空时使用官方资源池,传自托管资源池slave集群id时使用自托管资源池。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为[1-32]个字符。

默认取值

不涉及。

description

String

参数解释

主机集群描述信息。

约束限制

不涉及。

取值范围

字符串,长度为[0-500]个字符。

默认取值

不涉及。

is_proxy_mode

Integer

参数解释

是否为代理模式主机集群。

约束限制

不涉及。

取值范围

  • 0:非代理模式主机集群。

  • 1:代理模式主机集群。

默认取值

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

主机集群id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

请求示例

新建主机集群时需填写基本信息,信息包含主机集群名称、描述、操作系统、是否为代理机接入模式等。

https://{endpoint}/v1/resources/host-groups

{
  "name" : "test123",
  "description" : "",
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "os" : "linux",
  "slave_cluster_id" : "",
  "is_proxy_mode" : 1
}

响应示例

状态码: 200

OK 请求响应成功

{
  "status" : "success",
  "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
52
53
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 CreateHostClusterSolution {

    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();
        CreateHostClusterRequest request = new CreateHostClusterRequest();
        CreateHostClusterRequestBody body = new CreateHostClusterRequestBody();
        body.withIsProxyMode(1);
        body.withDescription("");
        body.withSlaveClusterId("");
        body.withOs(CreateHostClusterRequestBody.OsEnum.fromValue("linux"));
        body.withProjectId("6039d4480efc4dddb178abff98719913");
        body.withName("test123");
        request.withBody(body);
        try {
            CreateHostClusterResponse response = client.createHostCluster(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
37
38
# 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 = CreateHostClusterRequest()
        request.body = CreateHostClusterRequestBody(
            is_proxy_mode=1,
            description="",
            slave_cluster_id="",
            os="linux",
            project_id="6039d4480efc4dddb178abff98719913",
            name="test123"
        )
        response = client.create_host_cluster(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
45
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.CreateHostClusterRequest{}
	descriptionCreateHostClusterRequestBody:= ""
	slaveClusterIdCreateHostClusterRequestBody:= ""
	request.Body = &model.CreateHostClusterRequestBody{
		IsProxyMode: int32(1),
		Description: &descriptionCreateHostClusterRequestBody,
		SlaveClusterId: &slaveClusterIdCreateHostClusterRequestBody,
		Os: model.GetCreateHostClusterRequestBodyOsEnum().LINUX,
		ProjectId: "6039d4480efc4dddb178abff98719913",
		Name: "test123",
	}
	response, err := client.CreateHostCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码