GetRule - 获取指定授权规则详情 - 运维安全中心（堡垒机）

获取指定授权规则详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:GetRule		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	堡垒机实例的 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-wwo35essw07
RegionId	string	否	堡垒机的区域 ID。说明区域 ID 和区域名称的对应关系，请参见地域和可用区。	cn-beijing
RuleId	string	是	指定要查询的授权规则 ID。说明您可以调用 ListRules 接口获取该参数。	18

返回参数

名称	类型	描述	示例值
	object
RequestId	string	阿里云为该请求生成的唯一标识符。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Rule	object	授权规则信息。
Comment	string	授权规则备注。	comment
Databases	array<object>	已授权的数据库信息。
item	object
DatabaseAccounts	array<object>	已授权数据库账户信息。
item	object
DatabaseAccountId	string	已授权的数据库账户 ID。	5
DatabaseId	string	已授权的数据库实例 ID。	2
EffectiveEndTime	string	授权规则有效期结束时间（秒，时间戳格式）。	1698720972
EffectiveStartTime	string	授权规则有效期开始时间（秒，时间戳格式）。	1687140883
HostGroups	array<object>	已授权的资产组列表。
item	object
HostAccountNames	array	已授权资产账户信息。
item	string	资产组中已授权的账户名。	root
HostGroupId	string	已授权的资产组 ID。	7
Hosts	array<object>	已授权的主机信息。
item	object
HostAccounts	array<object>	已授权的主机账户列表。
item	object
HostAccountId	string	已授权的主机账户 ID。	9
HostId	string	已授权的主机 ID。	52
RuleId	string	授权规则 ID。	3
RuleName	string	授权规则名称。	rule
UserGroups	array<object>	已授权的用户组列表。
item	object
UserGroupId	string	已授权的用户组 ID。	2
Users	array<object>	已授权的用户列表。
item	object
UserId	string	已授权的用户 ID。	3

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
404	RuleNotFound	The rule is not found.	授权规则不存在
500	InternalError	An unknown error occurred.	未知错误

访问错误中心查看更多错误码。