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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-bastionhost:CreateRule | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The bastion host ID. Note
You can call the DescribeInstances operation to query the bastion host ID.
| bastionhost-cn-5yd2ymfsa0e |
| RegionId | string | No | 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 |
| RuleName | string | Yes | The name of the authorization rule. The name can be up to 128 characters in length. | rule |
| Comment | string | No | The remarks of the authorization rule. The remarks can be up to 500 characters in length. | comment |
| EffectiveStartTime | long | No | 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 |
| EffectiveEndTime | long | No | 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 |
| UserIds | array | No | An array that consists of user IDs. | |
| string | No | The user ID. Note
You can call the ListUsers operation to query the user ID.
| ["1"] | |
| UserGroupIds | array | No | An array that consists of user group IDs. | |
| string | No | The user group ID. Note
You can call the ListUserGroups operation to query the user group ID.
| ["1"] | |
| Hosts | array<object> | No | The host information. | |
| object | No | The host ID and the host account ID that you want to authorize to manage. | ||
| HostId | string | No | The host ID. | [{"HostId":"1"}] |
| HostAccountIds | array | No | An array that consists of host account IDs. | |
| string | No | The host account ID. | [{"HostId":"1","HostAccountIds":["1"]}] | |
| Databases | array<object> | No | The information about the database that runs on your server. | |
| object | No | The database ID and the database account ID that you want to authorize to manage. | ||
| DatabaseId | string | No | The database ID. | [ { "DatabaseId": "1" } ] |
| DatabaseAccountIds | array | No | An array that consists of database account IDs. | |
| string | No | The database account ID. | [ { "DatabaseId": "1", "DatabaseAccountIds": ["1", "2"] } ] | |
| HostGroups | array<object> | No | The information about the asset group that you want to authorize to manage. | |
| object | No | The asset group that you want to authorize to manage. | ||
| HostGroupId | string | No | The asset group ID. | [{"HostGroupId":"1"}] |
| HostAccountNames | array | No | An array that consists of asset account names. | |
| string | No | The username of the asset account. | [{"HostGroupId":"1","HostAccountNames":["root"]}] |
Hosts array
Host parameters
| Parameter | Type | Description |
|---|---|---|
| HostId | string | The host ID. |
| HostAccountIds | array[string] | An array that consists of host account IDs. |
HostGroups array
HostGroup parameters
| Parameter | Type | Description |
|---|---|---|
| HostGroupId | string | The host group ID. |
| HostAccountNames | array[string] | An array that consists of host account usernames. |
AssetGroup parameter
| Parameter | Type | Description |
|---|---|---|
| AssetGroupId | string | The asset group ID. |
| AssetAccountNames | array[string] | An array that consists of asset account usernames. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BFA818E3-0A53-51F4-8DB5-AF2A62A6D042",
"RuleId": "1"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 400 | RuleAlreadyExists | The rule already exists. | The rule already exists. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.