Call DescribePropertyScaItem to query asset fingerprints - Security Center - Alibaba Cloud - Security Center

Queries middleware fingerprints.

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

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	en
ForceFlush	boolean	No	Specifies whether to forcefully refresh the data that you want to query. Valid values: true: yes false: no	false
Biz	string	No	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
SearchItem	string	No	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.	type
SearchInfo	string	No	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.	system_service
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Note We recommend that you do not leave this parameter empty.	20

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	3F4236AB-7070-538D-85EB-98EBFE6C****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	27
Count	integer	The number of entries returned on the current page.	20
PropertyItems	array<object>	An array that consists of the information about middleware fingerprints.
	object	The information about middleware fingerprints.
TypeDisplay	string	The display name of the middleware type.	Docker Component
Name	string	The name of the middleware.	kubelet
Count	integer	The number of servers on which the middleware is run.	23
BizType	string	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	docker_component

Examples

Success response

JSON format

{
  "RequestId": "3F4236AB-7070-538D-85EB-98EBFE6C****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 27,
    "Count": 20
  },
  "PropertyItems": [
    {
      "TypeDisplay": "Docker Component",
      "Name": "kubelet",
      "Count": 23,
      "BizType": "docker_component"
    }
  ]
}

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.