DescribeWhiteListEffectiveAssets API Reference - Security Center - Alibaba Cloud - Security Center

Queries the servers on which an application whitelist policy takes effect.

Operation description

The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you have applied for a trial or are already using the feature, you can call this operation.

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-sas:DescribeWhiteListEffectiveAssets

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request, automatically obtained by the system. You do not need to specify this parameter.	27.212.XX.XX
Lang	string	No	The language of the request and response content. Default value: zh. Valid values: zh: Chinese en: English	zh
Remark	string	No	The filter condition for querying assets. You can enter an IP address, a public IP address, a private IP address, or an asset name for fuzzy match.	222.185.XX.XX
StrategyId	integer	No	The ID of the policy. Note You can call the DescribeWhiteListStrategyList operation to obtain the ID.	8437592
NeedStatistics	integer	No	Whether to return the number of untrusted programs. Valid values: 0: no 1: yes	0
PageSize	integer	No	The number of entries per page. Maximum value: 1000. Default value: 20. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The page number, starting from 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The request ID.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****
TotalCount	integer	The total number of servers on which the policy takes effect.	100
Count	integer	The number of entries returned on the current page.	10
Assets	array<object>	The servers on which the policy takes effect.
	object	The server on which the policy takes effect.
Uuid	string	The UUID of the server.	544900ff-1be7-4655-9719-6311cecb3****
StrategyId	integer	The ID of the policy.	35815387
StrategyName	string	The name of the policy.	test
InternetIp	string	The public IP address of the server.	60.205.XX.XX
SuspiciousEventCount	integer	The number of untrusted programs on the server.	5
ProcessMethod	integer	The exception handling mode. Valid values: 0: unhandled 1: alerted 2: blocked	1
MachineName	string	The name of the server.	test
IntranetIp	string	The private IP address of the server.	192.168.XX.XX

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "PageSize": 20,
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****",
  "TotalCount": 100,
  "Count": 10,
  "Assets": [
    {
      "Uuid": "544900ff-1be7-4655-9719-6311cecb3****",
      "StrategyId": 35815387,
      "StrategyName": "test",
      "InternetIp": "60.205.XX.XX",
      "SuspiciousEventCount": 5,
      "ProcessMethod": 1,
      "MachineName": "test",
      "IntranetIp": "192.168.XX.XX"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	-101	%s %s
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.