All Products
Search
Document Center

Security Center:DescribePropertyScaDetail

Last Updated:Feb 20, 2024

Queries middleware fingerprints.

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:DescribePropertyScaDetailRead
  • 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
zh
BizstringNo

The type of the asset fingerprint that you want to query. Default value: 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, which indicates that middleware fingerprints are queried.
sca
SearchItemstringNo

The type of the search condition. Valid values:

  • name: the name of a database, middleware, or web service
  • type: the type of a database, middleware, or web service
Note You must specify both the SearchItem and SearchInfo parameters before you can query the asset fingerprints based on the specified name or type.
name
SearchInfostringNo

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

  • If the SearchItem parameter is set to name, you must enter the name of an asset fingerprint.

  • If the SearchItem parameter is set to type, you must enter the type of an 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 both the SearchItem and SearchInfo parameters before you can query the asset fingerprints based on the specified name or type.
openssl
ScaNamestringNo

The name of the asset fingerprint that you want to query.

openssl
BizTypestringNo

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
SearchItemSubstringNo

The type of the subquery. Valid values:

  • port
  • pid
  • version
  • user
version
SearchInfoSubstringNo

The keyword of the subquery. You must specify this parameter based on the value of the SearchItemSub parameter.

  • If the SearchItemSub parameter is set to port, you must enter a port number.
  • If the SearchItemSub parameter is set to pid, you must enter a process ID (PID).
  • If the SearchItemSub parameter is set to version, you must enter the version of a database, middleware, or web service.
  • If the SearchItemSub parameter is set to user, you must enter a username.
Note The subquery is used to search for data of a specified database, middleware, or web service.
1.0.2k
RemarkstringNo

The search condition, such as a server name or a server IP address.

Note Fuzzy match is supported.
192.168
NamelongNo

The name of the middleware, database, or web service.

Note This parameter is deprecated. You can ignore it.
1
UuidstringNo

The UUID of the server on which the middleware, database, or web service is run.

uuid-02ebabe7-1c19-ab****
CurrentPageintegerNo

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

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

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

The version of the middleware, database, or web service.

1.0.2k
PortstringNo

The port that the process monitors.

68
UserstringNo

The user who runs the process.

root
PidstringNo

The PID.

756
ProcessStartedStartlongNo

The timestamp when the process starts. Unit: milliseconds.

1641024565
ProcessStartedEndlongNo

The timestamp when the process ends. Unit: milliseconds.

1641110965
ScaNamePatternstringNo

The name of the process.

open

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

F9146867-16C8-4AAB-BB4FB8C2A4
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 10.

20
TotalCountinteger

The total number of entries returned.

2
Countinteger

The number of entries returned on the current page.

2
Propertysobject []

The details about the asset fingerprints returned.

Typestring

The type of the middleware, database, or web service.

library
BizTypeDispalystring

The display name of the type of the middleware, database, or web service . Valid values:

  • System service
  • Software library
  • Container component
  • Database
  • Web container
  • JAR package
  • Web framework
System Service
ProcessStartedlong

The timestamp when the process starts. Unit: milliseconds.

1596539788
InternetIpstring

The public IP address of the server on which the middleware, database, or web service is run.

47.42.XX.XX
ConfigPathstring

The path to the configuration file.

/etc/my.cnf
Pidstring

The PID.

756
Portstring

The port of the middleware, database, or web service.

68
Cmdlinestring

The command line of the process.

/sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0
BizTypestring

The type of the middleware, database, or web service. 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
software_library
ListenIpstring

The IP address that the process monitors.

0.0.XX.XX
Versionstring

The version of the middleware, database, or web service.

1.0.2k
InstanceNamestring

The name of the server on which the middleware, database, or web service is run.

Test01
ListenStatusstring

The listening status of the process. Valid values:

  • NONE: not listening
  • LISTEN: listening
NONE
Namestring

The name of the middleware, database, or web service.

openssl
Ipstring

The public IP address of the server on which the middleware, database, or web service is run.

47.42.XX.XX
ProcessUserstring

The name of the user who runs the process.

root
InstanceIdstring

The ID of the server on which the middleware, database, or web service is run.

i-2zeclqj7ti****
WebPathstring

The web directory.

/usr/share/nginx/html
Ppidstring

The ID of the parent process.

1
IntranetIpstring

The private IP address of the server on which the middleware, database, or web service is run.

192.210.XX.XX
Uuidstring

The UUID of the server on which the middleware, database, or web service is run.

uuid-02ebabe7-1c19-a****
ListenProtocolstring

The protocol of the traffic on which the process listens. Valid values:

  • UDP
  • TCP
UDP
ImageNamestring

The name of the image.

registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****
Pathstring

The path of the middleware, database, or web service.

/usr/lib64/libssl.so.1.0.2k
ContainerNamestring

The name of the container.

5-rce_web_1
Proofstring

The version verification information about the middleware, database, or web service.

/usr/lib64/libssl.so.1.0.2k
CreateTimestamplong

The latest collection timestamp, which indicates the last timestamp when Security Center collected the information about the middleware, database, or web service. Unit: milliseconds.

1597987834000
RuntimeEnvVersionstring

The version of the runtime environment.

Note The value of this parameter can be the Java Development Kit (JDK) version of the runtime environment for a Java process.
1.8.0_144
PodNamestring

The name of the Kubernetes pod.

myapp-pod

Examples

Sample success responses

JSONformat

{
  "RequestId": "F9146867-16C8-4AAB-BB4FB8C2A4",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "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": "myapp-pod\n"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
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
2023-10-20The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.