GetPolicy - 获取指定控制策略详情 - 运维安全中心（堡垒机）

获取指定控制策略详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:GetPolicy

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	指定要查询的控制策略所在堡垒机的实例 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-zvp2d3syb0g
RegionId	string	否	指定要查询的控制策略所在堡垒机的区域 ID。说明区域 ID 和区域名称的对应关系，请参见地域和可用区。	cn-hangzhou
PolicyId	string	是	指定要查询的控制策略 ID。说明您可以调用ListPolicies 接口获取该参数。	3

返回参数

名称	类型	描述	示例值
	object
Policy	object	控制策略详细信息。
AccessTimeRangeConfig	object	登录时段限制详情。
EffectiveTime	array<object>	允许登录的时段详情。
	object
Days	array	允许登录的日期。
	string	允许登录的星期日期。 1：周一 2：周二 3：周三 4：周四 5：周五 6：周六 7：周日	[2]
Hours	array	允许登录的时间。
	string	每天允许登录的时间。取值： 0：0:00 到 1:00。 1：1:00 到 2:00。 2：2:00 到 3:00。 3：3:00 到 4:00。 4：4:00 到 5:00。 5：5:00 到 6:00。 6：6:00 到 7:00。 7：7:00 到 8:00。 8：8:00 到 9:00。 9：9:00 到 10:00。 10：10:00 到 11:00。 11：11:00 到 12:00。 12：12:00 到 13:00。 13：13:00 到 14:00。 14：14:00 到 15:00。 15：15:00 到 16:00。 16：16:00 到 17:00。 17：17:00 到 18:00。 18：18:00 到 19:00。 19：19:00 到 20:00。 20：20:00 到 21:00。 21：21:00 到 22:00。 22：22:00 到 23:00。 23：23:00 到 0:00。	[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]
CommandConfig	object	命令策略详情。
Approval	object	命令审批配置详情。
Commands	array	命令列表数组。
	string	已配置需要审批的命令详情。	ls
Deny	object	命令控制配置详情。
AclType	string	命令控制类型。取值： white：白名单模式。 black：黑名单模式。	black
Commands	array	命令列表数组。
	string	命令详情。	ls
Comment	string	控制策略的备注。	comment
IPAclConfig	object	来源 IP 限制配置详情。
AclType	string	来源 IP 限制模式。取值： white：白名单模式。 black：黑名单模式。	black
IPs	array	限制登录的 IP 信息。
	string	限制的 IP 列表。	[10.10..]
PolicyName	string	控制策略名称。	test
PolicyId	string	控制策略 ID。	3
Priority	integer	控制策略的优先级，数字越小优先级越高。	1
ProtocolConfig	object	协议控制详情。
RDP	object	RDP 选项配置详情。
ClipboardDownload	string	粘贴板下载配置。取值： Enable：启用 Disable：禁用	Enable
ClipboardUpload	string	粘贴板上传配置。取值： Enable：启用 Disable：禁用	Enable
DiskRedirection	string	驱动器/打印机映射配置。取值： Enable：启用 Disable：禁用	Enable
RecordKeyboard	string	键盘记录配置。取值： Enable：启用 Disable：禁用	Enable
SSH	object	SSH 和 SFTP 选项配置详情。
ExecCommand	string	远程执行命令配置。取值： Enable：启用 Disable：禁用	Enable
SFTPChannel	string	SFTP 通道配置。取值： Enable：启用 Disable：禁用	Enable
SFTPDownloadFile	string	SFTP 选项文件下载配置。取值： Enable：启用 Disable：禁用	Enable
SFTPMkdir	string	SFTP 选项创建文件夹配置。取值： Enable：启用 Disable：禁用	Enable
SFTPRemoveFile	string	SFTP 选项删除文件配置。取值： Enable：启用 Disable：禁用	Enable
SFTPRenameFile	string	SFTP 选项文件重命名配置。取值： Enable：启用 Disable：禁用	Enable
SFTPRmdir	string	SFTP 选项删除文件夹配置。取值： Enable：启用 Disable：禁用	Enable
SFTPUploadFile	string	SFTP 选项文件上传配置。取值： Enable：启用 Disable：禁用	Enable
SSHChannel	string	SSH 通道配置。取值： Enable：启用 Disable：禁用	Enable
X11Forwarding	string	X11 转发配置。取值： Enable：启用 Disable：禁用	Enable
ApprovalConfig	object	运维审批配置详情。
SwitchStatus	string	控制策略中的运维审批配置。取值： On：开启运维审批 Off：关闭运维审批	Off
RequestId	string	阿里云为该请求生成的唯一标识符。	0D29F2C0-8B4B-5861-9474-F3F23D25594B

示例

正常返回示例

JSON格式

{
  "Policy": {
    "AccessTimeRangeConfig": {
      "EffectiveTime": [
        {
          "Days": [
            "[2]"
          ],
          "Hours": [
            "[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]"
          ]
        }
      ]
    },
    "CommandConfig": {
      "Approval": {
        "Commands": [
          "ls"
        ]
      },
      "Deny": {
        "AclType": "black",
        "Commands": [
          "ls"
        ]
      }
    },
    "Comment": "comment",
    "IPAclConfig": {
      "AclType": "black",
      "IPs": [
        "[10.10.**.**]"
      ]
    },
    "PolicyName": "test",
    "PolicyId": "3",
    "Priority": 1,
    "ProtocolConfig": {
      "RDP": {
        "ClipboardDownload": "Enable",
        "ClipboardUpload": "Enable",
        "DiskRedirection": "Enable",
        "RecordKeyboard": "Enable"
      },
      "SSH": {
        "ExecCommand": "Enable",
        "SFTPChannel": "Enable",
        "SFTPDownloadFile": "Enable",
        "SFTPMkdir": "Enable",
        "SFTPRemoveFile": "Enable",
        "SFTPRenameFile": "Enable",
        "SFTPRmdir": "Enable",
        "SFTPUploadFile": "Enable",
        "SSHChannel": "Enable",
        "X11Forwarding": "Enable"
      }
    },
    "ApprovalConfig": {
      "SwitchStatus": "Off"
    }
  },
  "RequestId": "0D29F2C0-8B4B-5861-9474-F3F23D25594B"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The argument is invalid.	参数错误
500	InternalError	An unknown error occurred.	未知错误
404	PolicyNotFound	The policy is not found.	控制策略不存在

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

变更历史

更多信息，参考变更详情。