GetRule - Bastionhost - Alibaba Cloud Documentation Center

Queries the detailed information about an authorization rule.

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.

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetRule		All Resources ``	none	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 parameters

Parameter	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.
item	object
DatabaseAccounts	array<object>	The database accounts on which permissions are granted by using the authorization rule.
item	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.
item	object
HostAccountNames	array	The asset accounts on which permissions are granted by using the authorization rule.
item	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.
item	object
HostAccounts	array<object>	The host accounts that the policy authorizes users to manage.
item	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.
item	object
UserGroupId	string	The ID of the authorized user group.	2
Users	array<object>	The authorized users.
item	object
UserId	string	The ID of the authorized user.	3

Examples

Sample success responses

JSONformat

{
  "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.
404	RuleNotFound	The rule is not found.	The rule is not found.
500	InternalError	An unknown error occurred.	An unknown error occurred.

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