All Products
Search
Document Center

Bastionhost:CreateRule

Last Updated:Oct 25, 2024

You can create authorization rules to authorize multiple users to manage assets. You can also specify a validity period for an authorization rule. This way, you can manage users and assets in a more efficient manner and limit the time periods during which users can access assets.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:CreateRule
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The bastion host ID.

Note You can call the DescribeInstances operation to query the bastion host ID.
bastionhost-cn-5yd2ymfsa0e
RegionIdstringNo

The region ID of the bastion host.

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

The name of the authorization rule. The name can be up to 128 characters in length.

rule
CommentstringNo

The remarks of the authorization rule. The remarks can be up to 500 characters in length.

comment
EffectiveStartTimelongNo

The start time of the validity period of the authorization rule. Specify a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1669630029
EffectiveEndTimelongNo

The end time of the validity period of the authorization rule. Specify a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1672502400
UserIdsarrayNo

An array that consists of user IDs.

stringNo

The user ID.

Note You can call the ListUsers operation to query the user ID.
["1"]
UserGroupIdsarrayNo

An array that consists of user group IDs.

stringNo

The user group ID.

Note You can call the ListUserGroups operation to query the user group ID.
["1"]
Hostsarray<object>No

The host information.

objectNo

The host ID and the host account ID that you want to authorize to manage.

HostIdstringNo

The host ID.

[{"HostId":"1"}]
HostAccountIdsarrayNo

An array that consists of host account IDs.

stringNo

The host account ID.

[{"HostId":"1","HostAccountIds":["1"]}]
Databasesarray<object>No

The information about the database that runs on your server.

objectNo

The database ID and the database account ID that you want to authorize to manage.

DatabaseIdstringNo

The database ID.

[ { "DatabaseId": "1" } ]
DatabaseAccountIdsarrayNo

An array that consists of database account IDs.

stringNo

The database account ID.

[ { "DatabaseId": "1", "DatabaseAccountIds": ["1", "2"] } ]
HostGroupsarray<object>No

The information about the asset group that you want to authorize to manage.

objectNo

The asset group that you want to authorize to manage.

HostGroupIdstringNo

The asset group ID.

[{"HostGroupId":"1"}]
HostAccountNamesarrayNo

An array that consists of asset account names.

stringNo

The username of the asset account.

[{"HostGroupId":"1","HostAccountNames":["root"]}]

Hosts array

Host parameters

ParameterTypeDescription
HostIdstringThe host ID.
HostAccountIdsarray[string]An array that consists of host account IDs.

HostGroups array

HostGroup parameters

ParameterTypeDescription
HostGroupIdstringThe host group ID.
HostAccountNamesarray[string]An array that consists of host account usernames.

AssetGroup parameter

ParameterTypeDescription
AssetGroupIdstringThe asset group ID.
AssetAccountNamesarray[string]An array that consists of asset account usernames.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

BFA818E3-0A53-51F4-8DB5-AF2A62A6D042
RuleIdstring

The authorization rule ID.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "BFA818E3-0A53-51F4-8DB5-AF2A62A6D042",
  "RuleId": "1"
}

Error codes

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

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