All Products
Search
Document Center

Security Center:DescribeWhiteListAsset

Last Updated:Nov 25, 2024

Queries the information about servers that can be added or are added to application whitelist policies.

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

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-sas:DescribeWhiteListAssetget
*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.

180.119.XX.XX
LangstringNo

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

  • zh: Chinese
  • en: English
zh
LastMaxIdlongNo

The maximum asset ID of the most recent query.

1001
StrategyIdlongNo

The ID of the policy.

Note You can call the DescribeWhiteListStrategyList operation to obtain the ID.
2730
TypeintegerYes

The policy type of the asset that you want to query. Valid values:

  • 1: learning policy
  • 2: application policy
1
PageSizeintegerYes

The number of entries per page. Maximum value: 500. Default value: 500. This value indicates that 500 entries are displayed on each page.

20

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A3D7C47D-3F11-57BB-90E8-E5C20C61****
Assetsarray<object>

The information about the servers.

Assetobject

The information about the server.

Uuidstring

The UUID of the server.

5c081b02-f66a-47a4-bd2f-79ee3eaf806a
GroupIdlong

The group ID of the server.

11028551
MachineIpstring

The IP address of the server.

121.41.XX.XX
AllowSelectedinteger

Indicates whether the server can be selected. Valid values:

  • 0: no
  • 1: yes
1
Selectedinteger

Indicates whether the server is selected. Valid values:

  • 0: no
  • 1: yes
0
Idlong

The ID of the server.

1001
MachineNamestring

The name of the server.

test

Examples

Sample success responses

JSONformat

{
  "RequestId": "A3D7C47D-3F11-57BB-90E8-E5C20C61****",
  "Assets": [
    {
      "Uuid": "5c081b02-f66a-47a4-bd2f-79ee3eaf806a",
      "GroupId": 11028551,
      "MachineIp": "121.41.XX.XX",
      "AllowSelected": 1,
      "Selected": 0,
      "Id": 1001,
      "MachineName": "test"
    }
  ]
}

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.