All Products
Search
Document Center

Bastionhost:GetRule

Last Updated:Oct 25, 2024

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.

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:GetRule
  • 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-wwo35essw07
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-beijing
RuleIdstringYes

The ID of the authorization rule to query.

Note You can call the ListRules operation to query the authorization rule ID.
18

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Ruleobject

The returned information about the authorization rule.

Commentstring

The remarks of the authorization rule.

comment
Databasesarray<object>

The databases on which permissions are granted by using the authorization rule.

itemobject
DatabaseAccountsarray<object>

The database accounts on which permissions are granted by using the authorization rule.

itemobject
DatabaseAccountIdstring

The ID of the database account that the policy authorizes users to manage.

5
DatabaseIdstring

The ID of the database that the policy authorizes users to manage.

2
EffectiveEndTimestring

The end time of the validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.

1698720972
EffectiveStartTimestring

The start time of the validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.

1687140883
HostGroupsarray<object>

The asset groups on which permissions are granted by using the authorization rule.

itemobject
HostAccountNamesarray

The asset accounts on which permissions are granted by using the authorization rule.

itemstring

The username of the account that the policy authorizes users to manage in the asset group.

root
HostGroupIdstring

The ID of the asset group that the policy authorizes users to manage.

7
Hostsarray<object>

The information about the hosts that the policy authorizes users to manage.

itemobject
HostAccountsarray<object>

The host accounts that the policy authorizes users to manage.

itemobject
HostAccountIdstring

The ID of the host account that the policy authorizes users to manage.

9
HostIdstring

The ID of the host that the policy authorizes users to manage.

52
RuleIdstring

The ID of the authorization rule.

3
RuleNamestring

The name of the authorization rule.

rule
UserGroupsarray<object>

The authorized user groups.

itemobject
UserGroupIdstring

The ID of the authorized user group.

2
Usersarray<object>

The authorized users.

itemobject
UserIdstring

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 codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
404RuleNotFoundThe rule is not found.The rule is not found.
500InternalErrorAn unknown error occurred.An unknown error occurred.

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