You can call this operation to query the hosts that are included in the attack surface when a task instance scans an asset.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHostAttackSurfacesFacets

The operation that you want to perform. Set the value to DescribeHostAttackSurfacesFacets.

Host String Yes 1.2.3.4

The name of the host that you want to query.

TaskId Integer Yes 123456

The ID of the task that you want to query.

Response parameters

Parameter Type Example Description
CrawlerRequests Integer 300

The number of crawler requests.

Hosts Integer 10

The number of hosts.

Ports Integer 10

The number of ports.

RequestId String DD73CB0A-6E99-49AB-9569-5A00C9732795

The ID of the request.

WebPaths Integer 10

The number of web paths.

WebTechs Integer 10

The number of web applications.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeHostAttackSurfacesFacets
&<Common request parameters>

Sample success responses

XML format

<DescribeHostAttackSurfacesFacets>
	  <code>200</code>
	  <requestId>DD73CB0A-6E99-49AB-9569-5A00C9732795</requestId>
	  <success>true</success>
	  <data>
		    <CrawlerRequests>0</CrawlerRequests>
		    <Ports>304</Ports>
		    <WebPaths>14</WebPaths>
		    <WebServers>14</WebServers>
		    <WebTechs>2</WebTechs>
	  </data>
    </DescribeHostAttackSurfacesFacets>

JSON format

{
	"requestId":"DD73CB0A-6E99-49AB-9569-5A00C9732795",
	"data":{
		"CrawlerRequests":0,
		"WebPaths":14,
		"WebServers":14,
		"WebTechs":2,
		"Ports":304
	},
	"code":"200",
	"success":true
}

Error codes

For a list of error codes, visit the API Error Center.