GetPolicyAssetScope - Bastionhost - Alibaba Cloud Documentation Center

Queries the assets to which a control policy applies.

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

*All Resource

*

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-st220aw****
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-hangzhou
PolicyId	string	Yes	The control policy ID. Note You can call the ListPolicies operation to query the control policy ID.	7

Response elements

Element	Type	Description	Example
	object
AssetScope	object	The assets to which the control policy applies.
Databases	array<object>	The databases and database accounts to which the control policy applies.
	object
AccountScopeType	string	The scope of database accounts to which the control policy applies. Valid values: All: The control policy applies to all database accounts of the database. AccountId: The control policy applies to specified database accounts of the database.	AccountId
DatabaseAccountIds	array	The IDs of database accounts to which the control policy applies.
	string	The database account ID.	3
DatabaseId	string	The database ID.	17
HostGroups	array<object>	The asset groups and asset accounts to which the control policy applies.
	object
AccountNames	array	The asset accounts to which the control policy applies.
	string	The username of the asset account.	root
AccountScopeType	string	The scope of asset accounts to which the control policy applies. Valid values: All: The control policy applies to all accounts in the asset group. AccountName: The control policy applies to specified accounts in the asset group.	All
HostGroupId	string	The asset group ID.	4
Hosts	array<object>	The hosts and host accounts to which the control policy applies.
	object
AccountScopeType	string	The scope of host accounts to which the control policy applies. Valid values: All: The control policy applies to all accounts of the host. AccountId: The control policy applies to specified accounts of the host.	All
HostAccountIds	array	The host accounts to which the control policy applies.
	string	The host account IDs.	3
HostId	string	The host ID.	1
ScopeType	string	The scope of assets to which the control policy applies. If All is returned for this parameter, the control policy applies to all assets. If no value is returned for this parameter, the control policy applies to the assets specified in the return values of Databases, HostGroups, and Hosts.	All
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Success response

JSON format

{
  "AssetScope": {
    "Databases": [
      {
        "AccountScopeType": "AccountId",
        "DatabaseAccountIds": [
          "3\n"
        ],
        "DatabaseId": "17"
      }
    ],
    "HostGroups": [
      {
        "AccountNames": [
          "root"
        ],
        "AccountScopeType": "All",
        "HostGroupId": "4"
      }
    ],
    "Hosts": [
      {
        "AccountScopeType": "All",
        "HostAccountIds": [
          "3"
        ],
        "HostId": "1"
      }
    ],
    "ScopeType": "All"
  },
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.