All Products
Search
Document Center

Security Center:GetAssetsPropertyItem

Last Updated:Feb 20, 2024

Queries the aggregation information about the asset fingerprints of the startup item, kernel module, or website type.

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

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

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

  • zh: Chinese
  • en: English
en
ForceFlushbooleanNo

Specifies whether to forcefully refresh the data that you want to query. Valid values:

  • true: yes
  • false: no
false
BizstringYes

The type of the asset fingerprint that you want to query. Default value: sca. Valid values:

  • lkm: kernel module
  • autorun: startup item
  • web_server: website
lkm
SearchItemstringNo

The type of the search condition. You must specify this parameter based on the value of the Biz parameter. Valid values:

  • If you set Biz to web_server, set SearchItem to the following value:

    • domain: the domain name
  • If you set Biz to lkm, set SearchItem to the following value:

    • module_name: the name of the module
  • If you set Biz to autorun, set SearchItem to the following value:

    • path: the path to the self-starting item
Note You must specify both the SearchItem and SearchInfo parameters before you can query the information about asset fingerprints by asset fingerprint name.
path
SearchInfostringNo

The value of the search condition. You must specify this parameter based on the value of the SearchItem parameter.

  • If you set SearchItem to domain, you must enter the domain name.
  • If you set SearchItem to module_name, you must enter the module name.
  • If you set SearchItem to path, you must enter the path to the self-starting item.
Note You must specify both the SearchItem and SearchInfo parameters before you can query the information about asset fingerprints by asset fingerprint name.
/lib/systemd/s****
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

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

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

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

340D7FC4-D575-1661-8ACD-CFA7BE57****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

45
Countinteger

The number of entries returned on the current page.

20
PropertyItemsobject []

An array that consists of the aggregation information about asset fingerprints.

Countinteger

The number of servers related to the asset fingerprints.

23
Pathstring

The path to the startup item.

Note This parameter is returned only when Biz is set to autorun.
C:/Program Files/****
ModuleNamestring

The name of the module.

Note This parameter is returned only when Biz is set to lkm.
alihids
Domainstring

The endpoint.

Note This parameter is returned only when Biz is set to web_server.
localhost

Examples

Sample success responses

JSONformat

{
  "RequestId": "340D7FC4-D575-1661-8ACD-CFA7BE57****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 20
  },
  "PropertyItems": [
    {
      "Count": 23,
      "Path": "C:/Program Files/****",
      "ModuleName": "alihids",
      "Domain": "localhost"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParamIllegal param-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history