All Products
Search
Document Center

Bastionhost:GetPolicyAssetScope

Last Updated:Oct 25, 2024

Queries the assets to which a control policy applies.

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:GetPolicyAssetScope
  • 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-st220aw****
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-hangzhou
PolicyIdstringYes

The control policy ID.

Note You can call the ListPolicies operation to query the control policy ID.
7

Response parameters

ParameterTypeDescriptionExample
object
AssetScopeobject

The assets to which the control policy applies.

Databasesarray<object>

The databases and database accounts to which the control policy applies.

itemobject
AccountScopeTypestring

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
DatabaseAccountIdsarray

The IDs of database accounts to which the control policy applies.

itemstring

The database account ID.

["3"]
DatabaseIdstring

The database ID.

17
HostGroupsarray<object>

The asset groups and asset accounts to which the control policy applies.

itemobject
AccountNamesarray

The asset accounts to which the control policy applies.

itemstring

The username of the asset account.

root
AccountScopeTypestring

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
HostGroupIdstring

The asset group ID.

4
Hostsarray<object>

The hosts and host accounts to which the control policy applies.

itemobject
AccountScopeTypestring

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
HostAccountIdsarray

The host accounts to which the control policy applies.

itemstring

The host account IDs.

["3"]
HostIdstring

The host ID.

1
ScopeTypestring

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
RequestIdstring

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

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