Asset Fingerprint Software Details API Reference - Security Center - Alibaba Cloud - Security Center

Queries the details of software in the asset fingerprint collection.

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:DescribePropertySoftwareDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Remark	string	No	The name or IP address of the server to be queried.	192.168.XX.XX
Name	string	No	The name of the software to be queried.	kernel
Path	string	No	The installation path of the software.	/etc/test
SoftwareVersion	string	No	The version of the software.	3.10.0
Uuid	string	No	The UUID of the server.	50d213b4-3a35-427a-b8a5-****
CurrentPage	integer	No	The page number to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
InstallTimeStart	integer	No	The timestamp when the software update started. Unit: milliseconds.	1649321495000
InstallTimeEnd	integer	No	The timestamp when the software update ended. Unit: milliseconds.	1650012695000
Extend	string	No	Specifies whether to enable fuzzy search for the software name. Set to 1 to enable fuzzy search. Other values or an empty value disables fuzzy search.	1
UseNextToken	boolean	No	Specifies whether to use the NextToken method for pagination. When enabled, TotalCount is no longer returned. Valid values: true: Uses the NextToken method. false: Does not use the NextToken method.	true
NextToken	string	No	The pagination token. Leave empty to start from the beginning. Note You do not need to specify this parameter for the first request. The response includes a NextToken value that you can use in the next request. Each subsequent response provides the NextToken for the following request.	E17B501887A2D3AA5E8360A6EFA3B***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. You can use this ID for troubleshooting.	6AEE7412-0065-1135-B790-AE2C38BA68FB
PageInfo	object	The pagination information.
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries per page. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	1
Count	integer	The number of entries on the current page.	1
NextToken	string	The token for the next page of results.	B604532DEF982B875E8360A6EFA3B***
Propertys	array<object>	The software asset fingerprint details.
	object	The details of a software asset fingerprint entry.
InternetIp	string	The public IP address of the server.	192.168.XX.XX
Ip	string	The IP address of the server.	192.168.XX.XX
InstanceId	string	The instance ID of the server.	i-hp35tftuh52wbp1g****
IntranetIp	string	The private IP address of the server.	100.104.XX.XX
InstallTime	string	The installation time of the software.	2022-04-07 10:54:49
Uuid	string	The UUID of the server.	162eb349-c2d9-4f8b-805c-75b43d4c****
Version	string	The version of the software.	3.10.0
InstanceName	string	The name of the server instance.	hc-host-****
Path	string	The installation path of the software.	/etc/test
Name	string	The name of the software.	aaa_base
CreateTimestamp	integer	The timestamp of the latest asset fingerprint scan. Unit: milliseconds.	1649149566000
InstallTimeDt	integer	The installation timestamp of the software. Unit: milliseconds.	1649066826000

Examples

Success response

JSON format

{
  "RequestId": "6AEE7412-0065-1135-B790-AE2C38BA68FB",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Count": 1,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Propertys": [
    {
      "InternetIp": "192.168.XX.XX",
      "Ip": "192.168.XX.XX",
      "InstanceId": "i-hp35tftuh52wbp1g****",
      "IntranetIp": "100.104.XX.XX",
      "InstallTime": "2022-04-07 10:54:49",
      "Uuid": "162eb349-c2d9-4f8b-805c-75b43d4c****",
      "Version": "3.10.0",
      "InstanceName": "hc-host-****",
      "Path": "/etc/test",
      "Name": "aaa_base",
      "CreateTimestamp": 1649149566000,
      "InstallTimeDt": 1649066826000
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.