调用AddHostsToGroup接口批量将主机加入指定主机组。
使用说明
本接口用于批量将主机加入到指定的主机组当中。通过将多个主机加入到一个主机组,您可以集中管理这些主机,并进行批量授权。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddHostsToGroup |
需要执行的操作。 取值:AddHostsToGroup。 |
HostGroupId | String | 是 | 1 |
要加入主机的主机组ID。 说明 您可以调用ListHostGroups接口获取该参数。
|
HostIds | String | 是 | ["1","2","3"] |
要加入主机组的主机ID。该参数为JSON格式的字符串,最多支持添加100个主机ID。 说明 您可以调用ListHosts接口获取主机ID。
|
InstanceId | String | 是 | bastionhost-cn-st220aw**** |
要加入主机的主机组所在堡垒机的实例ID。 说明 您可以调用DescribeInstances接口获取该参数。
|
RegionId | String | 否 | cn-hangzhou |
要加入主机的主机组所在堡垒机的区域ID。 说明 区域ID和区域名称的对应关系,请参见地域和可用区。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 81500666-d7f5-4143-8329-0223cc738105 |
阿里云为该请求生成的唯一标识符。 |
Results | Array of Item |
接口的调用结果。 |
|
Code | String | OK |
接口调用的结果。取值:
|
HostGroupId | String | 1 |
主机组ID。 |
HostId | String | 1 |
主机ID。 |
Message | String | 无 |
该参数已废弃,无需关注。 |
示例
请求示例
http(s)://[Endpoint]/?Action=AddHostsToGroup
&HostGroupId=1
&HostIds=["1","2","3"]
&InstanceId=bastionhost-cn-st220aw****
&<公共请求参数>
正常返回示例
XML
格式
<AddHostsToGroupResponse>
<RequestId>81500666-d7f5-4143-8329-0223cc738105</RequestId>
<Results>
<HostGroupId>1</HostGroupId>
<HostId>1</HostId>
<Code>OK</Code>
</Results>
</AddHostsToGroupResponse>
JSON
格式
{
"RequestId": "81500666-d7f5-4143-8329-0223cc738105",
"Results": {
"HostGroupId": "1",
"Message": "",
"HostId": "1",
"Code": "OK"
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An unknown error occurred. | 未知错误 |
400 | InvalidParameter | The argument is invalid. | 参数错误 |
访问错误中心查看更多错误码。