创建主机组
功能介绍
创建主机组。当您需要对主机进行分组管理时,可调用该接口创建主机组,按照实际业务需求,创建对应的主机组进行主机管理。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/lts/host-group
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token,获取方式请参见:获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 用于定义消息体的格式,该字段填为:application/json;charset=utf8。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_group_name |
是 |
String |
参数解释: 主机组名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
host_group_type |
是 |
String |
参数解释: 主机组类型。支持两种主机组类型,分别为windows类型和linux类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及。 |
host_id_list |
否 |
Array of strings |
参数解释: 主机ID列表。主机类型必须与主机组类型保持一致。 约束限制: 不涉及。 |
host_group_tag |
否 |
Array of HostGroupTag objects |
参数解释: 主机组的标签信息。 约束限制: 最多支持20个标签。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
参数解释: 标签键。 约束限制:
取值范围:
默认取值: 不涉及。 |
value |
否 |
String |
参数解释: 标签值。 约束限制: 标签是以键值对(key-value)的形式表示,key和value为一一对应关系。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
host_group_id |
String |
参数解释: 主机组ID。 取值范围: 不涉及。 |
host_group_name |
String |
参数解释: 主机组名称。 取值范围: 不涉及。 |
host_group_type |
String |
参数解释: 主机组类型。 取值范围:
|
host_id_list |
Array of strings |
参数解释: 主机ID列表。 |
host_group_tag |
Array of HostGroupTagResBody objects |
参数解释: 主机组标签信息。 |
create_time |
Long |
参数解释: 主机组创建时间。 取值范围: 不涉及。 |
update_time |
Long |
参数解释: 主机组更新时间。 取值范围: 不涉及。 |
agent_access_type |
String |
参数解释: 主机组类型。分别为IP、LABEL类型。 取值范围: 不涉及。 |
labels |
Array of strings |
参数解释: 主机组自定义标识。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: 标签键。 取值范围: 不涉及。 |
value |
String |
参数解释: 标签值。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
请求示例
创建主机组,host_group_name和host_group_type为必填参数。
POST https://{endpoint}/v3/{project_id}/lts/host-group
{
"host_group_name" : "APIxx3",
"host_group_type" : "linxx",
"host_id_list" : [ "dc1dab7e-b045-4e77xxd1bf7", "713a9fxx2df-24c4ca599def" ],
"host_group_tag" : [ {
"key" : "xxx",
"value" : "xxx"
}, {
"key" : "xxx1",
"value" : "xxx"
} ]
}
响应示例
状态码:200
创建主机组请求响应成功。
{
"host_group_id" : "598c77aa-c69b-42f0-8cb8-983178ad5b38",
"host_group_name" : "devspore_app_dzhou1",
"host_group_type" : "linux",
"host_id_list" : [ "dc1dab7e-b045-4e77-bda4-914d083d1bf7", "xxxxx" ],
"host_group_tag" : [ {
"key" : "xxx",
"value" : "xxx"
} ],
"create_time" : 1635149410332,
"update_time" : 1635149410332
}
状态码:400
非法请求,建议根据error_msg直接修改该请求。
{
"error_code" : "LTS.1807",
"error_msg" : "Invalid host group id"
}
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{
"error_code" : "LTS.0010",
"error_msg" : "Internal Server Error"
}
SDK代码示例
SDK代码示例如下。
创建主机组,host_group_name和host_group_type为必填参数。
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 62 63 64 65 66 67 68 69 |
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class CreateHostGroupSolution {
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);
LtsClient client = LtsClient.newBuilder()
.withCredential(auth)
.withRegion(LtsRegion.valueOf("<YOUR REGION>"))
.build();
CreateHostGroupRequest request = new CreateHostGroupRequest();
CreateHostGroupRequestBody body = new CreateHostGroupRequestBody();
List<HostGroupTag> listbodyHostGroupTag = new ArrayList<>();
listbodyHostGroupTag.add(
new HostGroupTag()
.withKey("xxx")
.withValue("xxx")
);
listbodyHostGroupTag.add(
new HostGroupTag()
.withKey("xxx1")
.withValue("xxx")
);
List<String> listbodyHostIdList = new ArrayList<>();
listbodyHostIdList.add("dc1dab7e-b045-4e77xxd1bf7");
listbodyHostIdList.add("713a9fxx2df-24c4ca599def");
body.withHostGroupTag(listbodyHostGroupTag);
body.withHostIdList(listbodyHostIdList);
body.withHostGroupType(CreateHostGroupRequestBody.HostGroupTypeEnum.fromValue("linxx"));
body.withHostGroupName("APIxx3");
request.withBody(body);
try {
CreateHostGroupResponse response = client.createHostGroup(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());
}
}
}
|
创建主机组,host_group_name和host_group_type为必填参数。
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
.with_credentials(credentials) \
.with_region(LtsRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateHostGroupRequest()
listHostGroupTagbody = [
HostGroupTag(
key="xxx",
value="xxx"
),
HostGroupTag(
key="xxx1",
value="xxx"
)
]
listHostIdListbody = [
"dc1dab7e-b045-4e77xxd1bf7",
"713a9fxx2df-24c4ca599def"
]
request.body = CreateHostGroupRequestBody(
host_group_tag=listHostGroupTagbody,
host_id_list=listHostIdListbody,
host_group_type="linxx",
host_group_name="APIxx3"
)
response = client.create_host_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)
|
创建主机组,host_group_name和host_group_type为必填参数。
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 main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
lts.LtsClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateHostGroupRequest{}
keyHostGroupTag:= "xxx"
valueHostGroupTag:= "xxx"
keyHostGroupTag1:= "xxx1"
valueHostGroupTag1:= "xxx"
var listHostGroupTagbody = []model.HostGroupTag{
{
Key: &keyHostGroupTag,
Value: &valueHostGroupTag,
},
{
Key: &keyHostGroupTag1,
Value: &valueHostGroupTag1,
},
}
var listHostIdListbody = []string{
"dc1dab7e-b045-4e77xxd1bf7",
"713a9fxx2df-24c4ca599def",
}
request.Body = &model.CreateHostGroupRequestBody{
HostGroupTag: &listHostGroupTagbody,
HostIdList: &listHostIdListbody,
HostGroupType: model.GetCreateHostGroupRequestBodyHostGroupTypeEnum().LINXX,
HostGroupName: "APIxx3",
}
response, err := client.CreateHostGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
创建主机组,host_group_name和host_group_type为必填参数。
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 62 63 64 65 66 67 68 69 |
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class CreateHostGroupSolution {
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);
LtsClient client = LtsClient.newBuilder()
.withCredential(auth)
.withRegion(LtsRegion.valueOf("<YOUR REGION>"))
.build();
CreateHostGroupRequest request = new CreateHostGroupRequest();
CreateHostGroupRequestBody body = new CreateHostGroupRequestBody();
List<HostGroupTag> listbodyHostGroupTag = new ArrayList<>();
listbodyHostGroupTag.add(
new HostGroupTag()
.withKey("xxx")
.withValue("xxx")
);
listbodyHostGroupTag.add(
new HostGroupTag()
.withKey("xxx1")
.withValue("xxx")
);
List<String> listbodyHostIdList = new ArrayList<>();
listbodyHostIdList.add("dc1dab7e-b045-4e77xxd1bf7");
listbodyHostIdList.add("713a9fxx2df-24c4ca599def");
body.withHostGroupTag(listbodyHostGroupTag);
body.withHostIdList(listbodyHostIdList);
body.withHostGroupType(CreateHostGroupRequestBody.HostGroupTypeEnum.fromValue("linxx"));
body.withHostGroupName("APIxx3");
request.withBody(body);
try {
CreateHostGroupResponse response = client.createHostGroup(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());
}
}
}
|
创建主机组,host_group_name和host_group_type为必填参数。
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
.with_credentials(credentials) \
.with_region(LtsRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateHostGroupRequest()
listHostGroupTagbody = [
HostGroupTag(
key="xxx",
value="xxx"
),
HostGroupTag(
key="xxx1",
value="xxx"
)
]
listHostIdListbody = [
"dc1dab7e-b045-4e77xxd1bf7",
"713a9fxx2df-24c4ca599def"
]
request.body = CreateHostGroupRequestBody(
host_group_tag=listHostGroupTagbody,
host_id_list=listHostIdListbody,
host_group_type="linxx",
host_group_name="APIxx3"
)
response = client.create_host_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)
|
创建主机组,host_group_name和host_group_type为必填参数。
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 main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
lts.LtsClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateHostGroupRequest{}
keyHostGroupTag:= "xxx"
valueHostGroupTag:= "xxx"
keyHostGroupTag1:= "xxx1"
valueHostGroupTag1:= "xxx"
var listHostGroupTagbody = []model.HostGroupTag{
{
Key: &keyHostGroupTag,
Value: &valueHostGroupTag,
},
{
Key: &keyHostGroupTag1,
Value: &valueHostGroupTag1,
},
}
var listHostIdListbody = []string{
"dc1dab7e-b045-4e77xxd1bf7",
"713a9fxx2df-24c4ca599def",
}
request.Body = &model.CreateHostGroupRequestBody{
HostGroupTag: &listHostGroupTagbody,
HostIdList: &listHostIdListbody,
HostGroupType: model.GetCreateHostGroupRequestBodyHostGroupTypeEnum().LINXX,
HostGroupName: "APIxx3",
}
response, err := client.CreateHostGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
创建主机组请求响应成功。 |
400 |
非法请求,建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。