更新时间:2025-08-18 GMT+08:00

新建主机 (推荐)

功能介绍

在指定主机集群下新建主机。

调用方法

请参见如何调用API

URI

POST /v1/resources/host-groups/{group_id}/hosts

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

参数解释

主机集群id。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

消息体的类型(格式)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

host_name

String

参数解释

主机名称。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

ip

String

参数解释

主机IP。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

port

Integer

参数解释

主机ssh端口。

约束限制

不涉及。

取值范围

0-65535。

默认取值

不涉及。

os

String

参数解释

主机操作系统类型。

约束限制

不涉及。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

默认取值

不涉及。

as_proxy

Boolean

参数解释

是否是代理机。

约束限制

不涉及。

取值范围

  • true:是代理机。

  • false:非代理机。

默认取值

不涉及。

proxy_host_id

String

参数解释

代理机id。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

authorization

HostAuthorizationRequestBody object

参数解释

登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。

约束限制

不涉及。

install_icagent

Boolean

参数解释

是否安装icagent。

约束限制

不涉及。

取值范围

  • true:是。

  • false:否。

默认取值

不涉及。

表4 HostAuthorizationRequestBody

参数

是否必选

参数类型

描述

username

String

参数解释

登录主机用户名。

约束限制

不涉及。

取值范围

只能由字母、数字、下划线、中划线、点号、 @ 符号组成,长度[1-31]字符。

默认取值

不涉及。

password

String

参数解释

密码,认证类型为0时,密码必填。

约束限制

不涉及。

取值范围

不能包含空格、换行符、回车符、制表符、双引号和单引号,且长度[5-32]个字符。

默认取值

不涉及。

private_key

String

参数解释

密钥,认证类型为1时,密钥必填。

约束限制

不涉及。

取值范围

最大长度不超过5000个字符。

默认取值

不涉及。

trusted_type

Integer

参数解释

登录主机时认证类型。

约束限制

不涉及。

取值范围

  • 0:密码认证。

  • 1:密钥认证。

默认取值

0

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

id

String

参数解释

主机id。

取值范围

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

请求示例

新建主机时需填写主机基本信息,信息包含主机名称、IP地址、端口、用户名、密码等。

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

{
  "host_name" : "100.101.28.215",
  "ip" : "100.101.28.215",
  "port" : "22",
  "os" : "linux",
  "as_proxy" : false,
  "proxy_host_id" : "",
  "authorization" : {
    "username" : "root",
    "password" : "*****",
    "private_key" : "",
    "trusted_type" : 0
  },
  "install_icagent" : true
}

响应示例

状态码:200

OK 请求响应成功

{
  "status" : "success",
  "id" : "300d6d2e53624d0da08b182099ad10f7"
}

SDK代码示例

SDK代码示例如下。

Java

新建主机时需填写主机基本信息,信息包含主机名称、IP地址、端口、用户名、密码等。

 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
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 CreateHostSolution {

    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();
        CreateHostRequest request = new CreateHostRequest();
        request.withGroupId("{group_id}");
        CreateHostRequestBody body = new CreateHostRequestBody();
        HostAuthorizationBody authorizationbody = new HostAuthorizationBody();
        authorizationbody.withUsername("root")
            .withPassword("*****")
            .withPrivateKey("")
            .withTrustedType(HostAuthorizationBody.TrustedTypeEnum.NUMBER_0);
        body.withInstallIcagent(true);
        body.withAuthorization(authorizationbody);
        body.withProxyHostId("");
        body.withAsProxy(false);
        body.withOs(CreateHostRequestBody.OsEnum.fromValue("linux"));
        body.withPort(22);
        body.withIp("100.101.28.215");
        body.withHostName("100.101.28.215");
        request.withBody(body);
        try {
            CreateHostResponse response = client.createHost(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

新建主机时需填写主机基本信息,信息包含主机名称、IP地址、端口、用户名、密码等。

 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 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 = CreateHostRequest()
        request.group_id = "{group_id}"
        authorizationbody = HostAuthorizationBody(
            username="root",
            password="*****",
            private_key="",
            trusted_type=0
        )
        request.body = CreateHostRequestBody(
            install_icagent=True,
            authorization=authorizationbody,
            proxy_host_id="",
            as_proxy=False,
            os="linux",
            port=22,
            ip="100.101.28.215",
            host_name="100.101.28.215"
        )
        response = client.create_host(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

新建主机时需填写主机基本信息,信息包含主机名称、IP地址、端口、用户名、密码等。

 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 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.CreateHostRequest{}
	request.GroupId = "{group_id}"
	passwordAuthorization:= "*****"
	privateKeyAuthorization:= ""
	authorizationbody := &model.HostAuthorizationBody{
		Username: "root",
		Password: &passwordAuthorization,
		PrivateKey: &privateKeyAuthorization,
		TrustedType: model.GetHostAuthorizationBodyTrustedTypeEnum().E_0,
	}
	installIcagentCreateHostRequestBody:= true
	proxyHostIdCreateHostRequestBody:= ""
	request.Body = &model.CreateHostRequestBody{
		InstallIcagent: &installIcagentCreateHostRequestBody,
		Authorization: authorizationbody,
		ProxyHostId: &proxyHostIdCreateHostRequestBody,
		AsProxy: false,
		Os: model.GetCreateHostRequestBodyOsEnum().LINUX,
		Port: int32(22),
		Ip: "100.101.28.215",
		HostName: "100.101.28.215",
	}
	response, err := client.CreateHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码