GetRule - Bastionhost - Alibaba Cloud Documentation Center

Queries the detailed information about an 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

*All Resource

*

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-wwo35essw07
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-beijing
RuleId	string	Yes	The ID of the authorization rule to query. Note You can call the ListRules operation to query the authorization rule ID.	18

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Rule	object	The returned information about the authorization rule.
Comment	string	The remarks of the authorization rule.	comment
Databases	array<object>	The databases on which permissions are granted by using the authorization rule.
	array<object>
DatabaseAccounts	array<object>	The database accounts on which permissions are granted by using the authorization rule.
	object
DatabaseAccountId	string	The ID of the database account that the policy authorizes users to manage.	5
DatabaseId	string	The ID of the database that the policy authorizes users to manage.	2
EffectiveEndTime	string	The end time of the validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.	1698720972
EffectiveStartTime	string	The start time of the validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.	1687140883
HostGroups	array<object>	The asset groups on which permissions are granted by using the authorization rule.
	object
HostAccountNames	array	The asset accounts on which permissions are granted by using the authorization rule.
	string	The username of the account that the policy authorizes users to manage in the asset group.	root
HostGroupId	string	The ID of the asset group that the policy authorizes users to manage.	7
Hosts	array<object>	The information about the hosts that the policy authorizes users to manage.
	array<object>
HostAccounts	array<object>	The host accounts that the policy authorizes users to manage.
	object
HostAccountId	string	The ID of the host account that the policy authorizes users to manage.	9
HostId	string	The ID of the host that the policy authorizes users to manage.	52
RuleId	string	The ID of the authorization rule.	3
RuleName	string	The name of the authorization rule.	rule
UserGroups	array<object>	The authorized user groups.
	object
UserGroupId	string	The ID of the authorized user group.	2
Users	array<object>	The 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"
          }
        ],
        "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.