DescribePropertyScaDetail API Reference for Asset Fingerprint - Security Center

Retrieves details of middleware from the Asset Fingerprint page.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: `zh`. Valid values: `zh`: Chinese `en`: English	zh
Biz	string	No	The type of asset fingerprint that you want to query. The default value is `sca`. Valid values: `sca`: middleware `sca_database`: database `sca_web`: web service Note If you do not specify this parameter, the default value `sca` is used. This value indicates that you want to query the fingerprints of middleware assets.	sca
SearchItem	string	No	The type of the search condition. Valid values: `name`: the name of the middleware, database, or web service. `type`: the type of the middleware, database, or web service. Note You must specify the `SearchItem` and `SearchInfo` parameters at the same time to query asset fingerprints based on the name or type. If you specify only one of the parameters, the query fails.	name
SearchInfo	string	No	The content of the search. The content that you need to enter varies based on the value of the `SearchItem` parameter. If you set the `SearchItem` parameter to `name`, you must enter the name of the asset fingerprint. If you set the `SearchItem` parameter to `type`, you must select the type of the asset fingerprint. Valid values: `system_service`: system service `software_library`: software library `docker_component`: container component `database`: database `web_container`: web container `jar`: JAR package `web_framework`: web framework Note You must specify the `SearchItem` and `SearchInfo` parameters at the same time to query asset fingerprints based on the name or type. If you specify only one of the parameters, the query fails.	openssl
SearchCriteriaList	array<object>	No	The search conditions.
	object	No	The search condition.
Name	string	No	The name of the search condition.	Name
Value	string	No	The filter value of the search condition.	test
ScaName	string	No	The name of the asset fingerprint that you want to query.	openssl
BizType	string	No	The type of the middleware, database, or web service that you want to query. Valid values: `system_service`: system service `software_library`: software library `docker_component`: container component `database`: database `web_container`: web container `jar`: JAR package `web_framework`: web framework	system_service
SearchItemSub	string	No	The type of the sub-query condition. Valid values: `port`: port `pid`: process ID (PID) `version`: version `user`: user	version
SearchInfoSub	string	No	The content of the sub-query. The content that you must enter varies based on the value of the `SearchItemSub` parameter. If you set the `SearchItemSub` parameter to `port`, you must enter a port number for the sub-query. If you set the `SearchItemSub` parameter to `pid`, you must enter a PID for the sub-query. If you set the `SearchItemSub` parameter to `version`, you must enter the version of the middleware, database, or web service for the sub-query. If you set the `SearchItemSub` parameter to `user`, you must enter a username for the sub-query. Note You can use sub-query conditions to query the data of a specified middleware, database, or web service.	1.0.2k
Remark	string	No	The search condition, which can be the name or IP address of a server. Note Fuzzy search is supported.	192.168
Name	integer	No	The name of the middleware, database, or web service. Note This parameter is deprecated.	1
Uuid	string	No	The UUID of the server on which the middleware, database, or web service runs.	uuid-02ebabe7-1c19-ab****
CurrentPage	integer	No	The page number. Default value: `1`.	1
PageSize	integer	No	The number of entries to return on each page. Default value: `10`. Note We recommend that you do not leave this parameter empty.	10
ScaVersion	string	No	The version of the middleware, database, or web service.	1.0.2k
Port	string	No	The listening port of the process.	68
User	string	No	The user that runs the process.	root
Pid	string	No	The process ID (PID).	756
ProcessStartedStart	integer	No	The beginning of the time range to query the process startup time. This value is a UNIX timestamp. Unit: seconds.	1641024565
ProcessStartedEnd	integer	No	The end of the time range to query the process startup time. This value is a UNIX timestamp. Unit: seconds.	1641110965
ScaNamePattern	string	No	The process name.	open
UseNextToken	boolean	No	Specifies whether to use the NextToken parameter to query the asset list. If you set this parameter to true, the TotalCount parameter is not returned. Valid values: `true`: uses the NextToken parameter. `false`: does not use the NextToken parameter.	true
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. Note You must specify the token that is obtained from the previous query as the value of NextToken.	AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F9146867-16C8-4AAB-BB4FB8C2A4
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of asset fingerprint entries returned per page. Default value: 10.	20
TotalCount	integer	The total number of asset fingerprint entries that match the query criteria.	2
Count	integer	The number of entries returned on the current page.	2
NextToken	string	The token that is used to retrieve the next page of results.	B60***
Propertys	array<object>	An array of asset fingerprints.
	object
Type	string	The type of the middleware, database, or web service.	library
BizTypeDispaly	string	The display name of the asset type. Valid values: System Service Software Library Container Component Database Web Container JAR Package Web Framework System Service Software Library Docker Component Database Web Container JAR package Web Framework	System Service
ProcessStarted	integer	The timestamp when the process started. Unit: seconds.	1596539788
InternetIp	string	The public IP address of the server on which the asset is located.	47.42.XX.XX
ConfigPath	string	The path to the configuration file.	/etc/my.cnf
Pid	string	The process ID (PID).	756
Port	string	The port used by the middleware, database, or web service.	68
Cmdline	string	The process command line.	/sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0
BizType	string	The type of the asset. Valid values: system_service: system service software_library: software library docker_component: Docker component database: database web_container: web container jar: JAR package web_framework: web framework	software_library
ListenIp	string	The listening IP address.	0.0.XX.XX
Version	string	The version of the middleware, database, or web service.	1.0.2k
InstanceName	string	The name of the instance on which the asset is located.	Test01
ListenStatus	string	The listening state of the process. Valid values: NONE: not listening LISTEN: listening	NONE
Name	string	The name of the middleware, database, or web service.	openssl
Ip	string	The public IP address of the server on which the asset is located.	47.42.XX.XX
ProcessUser	string	The user that runs the process.	root
InstanceId	string	The ID of the instance on which the asset is located.	i-2zeclqj7ti****
WebPath	string	The path to the web directory.	/usr/share/nginx/html
Ppid	string	The parent process ID (PPID).	1
IntranetIp	string	The private IP address of the server on which the asset is located.	192.210.XX.XX
Uuid	string	The UUID of the server on which the asset is located.	uuid-02ebabe7-1c19-a****
ListenProtocol	string	The listening protocol. Valid values: UDP TCP	UDP
ImageName	string	The name of the image.	registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****
Path	string	The path to the middleware, database, or web service.	/usr/lib64/libssl.so.1.0.2k
ContainerName	string	The name of the container.	5-rce_web_1
Proof	string	The information used to verify the version of the asset.	/usr/lib64/libssl.so.1.0.2k
CreateTimestamp	integer	The timestamp when Security Center last collected the fingerprint of the asset. Unit: milliseconds.	1597987834000
RuntimeEnvVersion	string	The version of the runtime environment. Note For example, the JDK version for a Java process.	1.8.0_144
PodName	string	The name of the pod.	hello-pod

Examples

Success response

JSON format

{
  "RequestId": "F9146867-16C8-4AAB-BB4FB8C2A4",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2,
    "NextToken": "B60***"
  },
  "Propertys": [
    {
      "Type": "library",
      "BizTypeDispaly": "System Service",
      "ProcessStarted": 1596539788,
      "InternetIp": "47.42.XX.XX",
      "ConfigPath": "/etc/my.cnf",
      "Pid": "756",
      "Port": "68",
      "Cmdline": "/sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0",
      "BizType": "software_library",
      "ListenIp": "0.0.XX.XX",
      "Version": "1.0.2k",
      "InstanceName": "Test01",
      "ListenStatus": "NONE",
      "Name": "openssl",
      "Ip": "47.42.XX.XX",
      "ProcessUser": "root",
      "InstanceId": "i-2zeclqj7ti****",
      "WebPath": "/usr/share/nginx/html",
      "Ppid": "1",
      "IntranetIp": "192.210.XX.XX",
      "Uuid": "uuid-02ebabe7-1c19-a****",
      "ListenProtocol": "UDP",
      "ImageName": "registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****",
      "Path": "/usr/lib64/libssl.so.1.0.2k",
      "ContainerName": "5-rce_web_1",
      "Proof": "/usr/lib64/libssl.so.1.0.2k",
      "CreateTimestamp": 1597987834000,
      "RuntimeEnvVersion": "1.8.0_144",
      "PodName": "hello-pod"
    }
  ]
}

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.