Skip to main content

DescribeTarget

Description

obtain the scope of host assets detected by the specified vulnerability type in the vulnerability management configuration.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeTarget

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
TypeBODYstringNoNo sample value for this parameter.type, such as vul indicates a vulnerability.
regionIdBODYstringYesNo sample value for this parameter.region id
ConfigBODYstringNoNo sample value for this parameter.vulnerability classification information, expressed in JSON format. For example,{"vulType":"cve"} represents Linux software vulnerability classification.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
TotalCountintegerno demo valuereturns the total number of records.
Targetstringno demo valueasset group ID or host asset UUID.
RequestIdstringno demo valuerequest ID.
nametypeno demo valueDescription
TargetTypestringno demo valueThe type of Target parameter value: groupId: indicates asset group ID uuid: indicates the host asset UUID
Targetsarrayno demo valuelist of host asset detection ranges. see the following parameter description for specific sub-items.

Example

Successful Response example

{
"TotalCount":"no demo value",
"Target":"no demo value",
"RequestId":"no demo value",
"name":"no demo value",
"TargetType":"no demo value",
"Targets":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}