DescribePropertyScaItem - Security Center - Alibaba Cloud Documentation Center

Queries middleware fingerprints.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribePropertyScaItem	get	All Resources *	none	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 parameters

Parameter	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.
PropertyItems	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

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-03-13	The internal configuration of the API is changed, but the call is not affected	View Change Details