All Products
Search
Document Center

Security Center:DescribeWhiteListEffectiveAssets

Last Updated:Aug 28, 2024

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 applied for a trial of the feature or the feature is in-use, you can call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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-sas:DescribeWhiteListEffectiveAssetsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.

27.212.XX.XX
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
RemarkstringNo

The condition that is used to query assets. You can enter an IP address, a public IP address, an private IP address, or an asset name for fuzzy match.

222.185.XX.XX
StrategyIdlongNo

The ID of the policy.

Note You can call the DescribeWhiteListStrategyList operation to obtain the ID.
8437592
NeedStatisticsintegerNo

Specifies whether to return the number of untrusted programs. Valid values:

  • 0: no
  • 1: yes
0
PageSizeintegerNo

The number of entries per page. Maximum value: 1000. Default value: 20. If you leave this parameter empty, 20 data entries are returned per page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The page number. Default value: 1. Pages start from page 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
RequestIdstring

The request ID.

A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****
TotalCountinteger

The total number of the servers on which the policy takes effect.

100
Countinteger

The number of entries returned on the current page.

10
Assetsarray<object>

The servers on which the policy takes effect.

object

The server on which the policy takes effect.

Uuidstring

The UUID of the server.

544900ff-1be7-4655-9719-6311cecb3****
StrategyIdlong

The ID of the policy.

35815387
StrategyNamestring

The name of the policy.

test
InternetIpstring

The public IP address of the server.

60.205.XX.XX
SuspiciousEventCountinteger

The number of untrusted programs on the server.

5
ProcessMethodinteger

The exception handling mode. Valid values:

  • 0: unhandled
  • 1: alerted
  • 2: blocked
1
MachineNamestring

The name of the server.

test
IntranetIpstring

The private IP address.

192.168.XX.XX

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400-101%s %s-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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