Query authorization rule details using GetRule - Bastionhost - Alibaba Cloud - Bastionhost

Retrieves the details of a specified authorization rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:GetRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance. Note You can call the DescribeInstances operation to retrieve this parameter.	bastionhost-cn-wwo35essw07
RegionId	string	No	The region ID of the Bastionhost instance. Note For the mappings between region IDs and region names, see Regions and zones.	cn-beijing
RuleId	string	Yes	The ID of the authorization rule to query. Note You can call the ListRules operation to retrieve this parameter.	18
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique identifier generated by Alibaba Cloud for the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Rule	object	The authorization rule information.
Comment	string	The comment of the authorization rule.	comment
Databases	array<object>	The information about the authorized databases.
	array<object>
DatabaseAccounts	array<object>	The information about the authorized database accounts.
	object
DatabaseAccountId	string	The ID of the authorized database account.	5
DatabaseId	string	The instance ID of the authorization database.	2
EffectiveEndTime	string	The end time of the validity period of the authorization rule. The value is a UNIX timestamp in seconds.	1698720972
EffectiveStartTime	string	The start time of the validity period of the authorization rule. The value is a UNIX timestamp in seconds.	1687140883
HostGroups	array<object>	The list of authorized host groups.
	object
HostAccountNames	array	The information about the authorized host accounts.
	string	The name of the authorized account in the host group.	root
HostGroupId	string	The ID of the authorized host group.	7
Hosts	array<object>	The information about the authorized hosts.
	array<object>
HostAccounts	array<object>	The list of authorized host accounts.
	object
HostAccountId	string	The ID of the authorized host account.	9
HostAccountName	string	The name of the authorized host account.	root
HostId	string	The ID of the authorized host.	52
RuleId	string	The ID of the authorization rule.	3
RuleName	string	The name of the authorization rule.	rule
UserGroups	array<object>	The list of authorized user groups.
	object
UserGroupId	string	The ID of the authorized user group.	2
Users	array<object>	The list of authorized users.
	object
UserId	string	The ID of the authorized user.	3

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Rule": {
    "Comment": "comment",
    "Databases": [
      {
        "DatabaseAccounts": [
          {
            "DatabaseAccountId": "5"
          }
        ],
        "DatabaseId": "2"
      }
    ],
    "EffectiveEndTime": "1698720972",
    "EffectiveStartTime": "1687140883",
    "HostGroups": [
      {
        "HostAccountNames": [
          "root"
        ],
        "HostGroupId": "7"
      }
    ],
    "Hosts": [
      {
        "HostAccounts": [
          {
            "HostAccountId": "9",
            "HostAccountName": "root"
          }
        ],
        "HostId": "52"
      }
    ],
    "RuleId": "3",
    "RuleName": "rule",
    "UserGroups": [
      {
        "UserGroupId": "2"
      }
    ],
    "Users": [
      {
        "UserId": "3"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	RuleNotFound	The rule is not found.	The rule is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.