All Products
Search
Document Center

Bastionhost:AddHostsToGroup

Last Updated:Dec 28, 2023

Adds one or more hosts to the specified host group.

Operation description

You can call this operation to add one or more hosts to a host group. You can add multiple hosts to a host group to manage and grant permissions on the hosts in a centralized manner.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:AddHostsToGroupWrite
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host for which you want to add hosts to the host group.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-st220aw****
RegionIdstringNo

The region ID of the bastion host for which you want to add hosts to the host group.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
HostGroupIdstringYes

The ID of the host group to which you want to add hosts.

Note You can call the ListHostGroups operation to query the ID of the host group.
1
HostIdsstringYes

The ID of the host that you want to add to the host group. The value is a JSON string. You can add up to 100 host IDs.

Note You can call the ListHosts operation to query the IDs of hosts.
["1","2","3"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

81500666-d7f5-4143-8329-0223cc738105
Resultsobject []

The result of the call.

Codestring

The return code that indicates whether the call was successful. Valid values:

  • OK: The call was successful.

  • UNEXPECTED: An unknown error occurred.

  • INVALID_ARGUMENT: A request parameter is invalid.

Note Make sure that the request parameters are valid and call the operation again.
  • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.
Note Check whether the specified ID of the bastion host exists, whether the specified hosts exist, and whether the specified host IDs are valid. Then, call the operation again.
  • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.
OK
Messagestring

This parameter is deprecated.

N/A
HostGroupIdstring

The ID of the host group.

1
HostIdstring

The ID of the host.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "81500666-d7f5-4143-8329-0223cc738105",
  "Results": [
    {
      "Code": "OK",
      "Message": "N/A\n",
      "HostGroupId": "1",
      "HostId": "1"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.