You can call this operation to query domain names 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 DescribeDomains

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

TaskId Integer Yes 12345

The ID of the task that you want to query.

Asset String No foo.com

The name of the asset whose domains are queried.

CurrentPage Integer No 1

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

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. This is the maximum value.

Response parameters

Parameter Type Example Description
Records

The list of returned records.

Domain String foo.com

The domain name.

Index Integer 1

The index number of the returned record.

UpdatedAt Long 1561392000000

The time when the scan was performed.

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

The ID of the request.

Total Integer 10000

The number of returned entries.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeDomains>
	  <code>200</code>
	  <requestId>DD73CB0A-6E99-49AB-9569-5A00C9732795</requestId>
	  <success>true</success>
	  <data>
		    <Records>
			      <Index>1</Index>
			      <Domain>www.foo.com</Domain>
			      <UpdatedAt>1561392000000</UpdatedAt>
		    </Records>
		    <Records>
			      <Index>2</Index>
			      <Domain>www.abc.com</Domain>
			      <UpdatedAt>1561392000000</UpdatedAt>
		    </Records>
	  </data>
</DescribeDomains>

JSON format

{
	"requestId":"DD73CB0A-6E99-49AB-9569-5A00C9732795",
	"data":{
		"Records":[
			{
				"UpdatedAt":1561392000000,
				"Index":1,
				"Domain":"www.foo.com"
			},
			{
				"UpdatedAt":1561392000000,
				"Index":2,
				"Domain":"www.abc.com"
			}
		]
	},
	"code":"200",
	"success":true
}

Error codes

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