GetPolicy - Bastionhost - Alibaba Cloud Documentation Center

Queries the detailed information about a control policy.

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:GetPolicy

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host to which the control policy to query belongs. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-zvp2d3syb0g
RegionId	string	No	The region ID of the bastion host to which the control policy to query belongs. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PolicyId	string	Yes	The ID of the control policy that you want to query. Note You can call the ListPolicies operation to query the control policy ID.	3

Response elements

Element	Type	Description	Example
	object
Policy	object	The details of the control policy.
AccessTimeRangeConfig	object	The details of the logon period restrictions.
EffectiveTime	array<object>	The details of the periods during which logons are allowed.
	object
Days	array	The days of a week on which logons are allowed.
	string	The day of the week during which logons are allowed. Valid values: 1: Monday. 2: Tuesday. 3: Wednesday. 4: Thursday. 5: Friday. 6: Saturday. 7: Sunday.	[2]
Hours	array	The time periods during which logons are allowed.
	string	The periods of the day during which logons are allowed. Valid values: 0: 00:00 to 01:00. 1: 01:00 to 02:00. 2: 02:00 to 03:00. 3: 03:00 to 04:00. 4: 04:00 to 05:00. 5: 05:00 to 06:00. 6: 06:00 to 07:00. 7: 07:00 to 08:00. 8: 08:00 to 09:00. 9: 09:00 to 10:00. 10: 10:00 to 11:00. 11: 11:00 to 12:00. 12: 12:00 to 13:00. 13: 13:00 to 14:00. 14: 14:00 to 15:00. 15: 15:00 to 16:00. 16: 16:00 to 17:00. 17: 17:00 to 18:00. 18: 18:00 to 19:00. 19: 19:00 to 20:00. 20: 20:00 to 21:00. 21: 21:00 to 22:00. 22: 22:00 to 23:00. 23: 23:00 to 24: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	The details of the command policy.
Approval	object	The details of the command approval settings.
Commands	array	An array of commands that can be run only after approval.
	string	The command that can be run only after approval.	ls
Deny	object	The details of the command control setting.
AclType	string	The type of command control. Valid values: white: whitelist mode. black: blacklist mode.	black
Commands	array	An array of controlled commands.
	string	The controlled command.	ls
Comment	string	The description of the control policy.	comment
IPAclConfig	object	The access control settings on source IP addresses.
AclType	string	The mode of access control on source IP addresses. Valid values: white: whitelist mode. black: blacklist mode.	black
IPs	array	The IP addresses from which logons are not allowed.
	string	The controlled IP addresses.	[10.10..]
PolicyName	string	The name of the control policy.	test
PolicyId	string	The ID of the control policy.	3
Priority	integer	The priority of the control policy. A smaller value indicates a higher priority.	1
ProtocolConfig	object	The details of protocol control.
RDP	object	The configuration details of Remote Desktop Protocol (RDP) options.
ClipboardDownload	string	Indicates whether downloading from the clipboard is enabled. Valid values: Enable Disable	Enable
ClipboardUpload	string	Indicates whether file uploading from the clipboard is enabled. Valid values: Enable Disable	Enable
DiskRedirection	string	Indicates whether driver mapping is enabled. Valid values: Enable Disable	Enable
RecordKeyboard	string	Indicates whether keyboard recording is enabled. Valid values: Enable Disable	Enable
SSH	object	The configuration details of SSH and SSH File Transfer Protocol (SFTP) options.
ExecCommand	string	Indicates whether remote command execution is enabled. Valid values: Enable Disable	Enable
SFTPChannel	string	Indicates whether the SFTP channel option is enabled. Valid values: Enable Disable	Enable
SFTPDownloadFile	string	Indicates whether file downloading is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SFTPMkdir	string	Indicates whether folder creation is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SFTPRemoveFile	string	Indicates whether file deletion is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SFTPRenameFile	string	Indicates whether file renaming is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SFTPRmdir	string	Indicates whether folder deletion is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SFTPUploadFile	string	Indicates whether file uploading is enabled in SFTP-based O&M. Valid values: Enable Disable	Enable
SSHChannel	string	Indicates whether the SSH channel option is enabled. Valid values: Enable Disable	Enable
X11Forwarding	string	Indicates whether X11 forwarding is enabled. Valid values: Enable Disable	Enable
ApprovalConfig	object	The O&M approval setting.
SwitchStatus	string	Indicates whether O&M approval is enabled in the control policy. Valid values: On: O&M approval is enabled. Off: O&M approval is disabled.	Off
RequestId	string	The request ID.	0D29F2C0-8B4B-5861-9474-F3F23D25594B

Examples

Success response

JSON format

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

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	PolicyNotFound	The policy is not found.	The policy is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.