Queries the details of a domain 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 DescribeDomainDetail

The operation that you want to perform.

Set the value to DescribeDomainDetail.

DomainName String Yes example.com

The name of the domain or website.

Note Fuzzy match is not supported. You must enter a complete domain name or a website.
SourceIp String No 1.2.3.4

The source IP address of the request.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
AlarmCount Integer 2

The total number of alerts in your website assets.

Domain String example.com

The name of the returned domain.

DomainDetailItems Array of DomainDetailItem

The details of the domain asset.

AssetType String 0

The type of the asset. Valid values:

  • 0: Elastic Compute Service (ECS) instance
  • 1: Server Load Balancer (SLB) instance
  • 2: NAT gateway instance
  • 3: ApsaraDB RDS instance
  • 4: ApsaraDB for MongoDB instance
InstanceId String i-m5e6w7dzsktt6mz4***

The ID of the asset instance.

InstanceName String iZm5e6w7dzsktt6mz4yimeZ-6****

The name of the asset instance.

InternetIp String 1.2.XX.XX

The public IP address of the asset instance.

IntranetIp String 1.2.XX.XX

The private IP address of the asset instance.

Uuid String lb-bp1g9dohoyin9cjhn6itt

The UUID of the asset instance.

RequestId String 3A85CFCF-05C8-451A-9E41-C0D5E96BA407

The ID of the request.

RootDomain String tst.com

The name of the root domain that corresponds to the returned domain.

VulCount Integer 2

The total number of vulnerabilities in your website assets.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDomainDetail
&DomainName=*.test.com
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainDetailResponse>
      <DomainDetailItems>
            <InstanceName>iZm5e6***</InstanceName>
            <AssetType>0</AssetType>
            <Uuid>d664e15e-488b-4f3c-a80f-***</Uuid>
            <InternetIp>1.2.XX.XX</InternetIp>
            <InstanceId>i-m5e***e</InstanceId>
            <IntranetIp>1.2.XX.XX</IntranetIp>
      </DomainDetailItems>
      <DomainDetailItems>
            <InstanceName>iZ***</InstanceName>
            <AssetType>0</AssetType>
            <Uuid>0d804403-8d36-4642-a5f1-***</Uuid>
            <InternetIp>1.2.XX.XX</InternetIp>
            <InstanceId>i-m5ehn8ugwvsp2k4x****</InstanceId>
            <IntranetIp>1.2.XX.XX</IntranetIp>
      </DomainDetailItems>
      <DomainDetailItems>
            <AssetType>2</AssetType>
            <Uuid>eip-wz9***</Uuid>
            <InternetIp>1.2.XX.XX</InternetIp>
            <InstanceId>eip-wz9***</InstanceId>
      </DomainDetailItems>
      <DomainDetailItems>
            <InstanceName>abc</InstanceName>
            <AssetType>1</AssetType>
            <Uuid>lb-bp***</Uuid>
            <InternetIp>1.2.XX.XX</InternetIp>
            <InstanceId>lb-bp***</InstanceId>
      </DomainDetailItems>
      <Domain>example.com</Domain>
      <RequestId>3A85CFCF-05C8-451A-9E41-C0D5E96BA407</RequestId>
      <RootDomain>example.com</RootDomain>
      <VulCount>0</VulCount>
      <AlarmCount>0</AlarmCount>
</DescribeDomainDetailResponse>

JSON format

{


	"DomainDetailItems": [{
			"InstanceName": "iZm5e6***",
			"AssetType": 0,
			"Uuid": "d664e15e-488b-4f3c-a80f-***",
			"InternetIp": "1.2.XX.XX",
			"InstanceId": "i-m5e***e",
			"IntranetIp": "1.2.XX.XX"
		},
		{
			"InstanceName": "iZ***",
			"AssetType": 0,
			"Uuid": "0d804403-8d36-4642-a5f1-***",
			"InternetIp": "1.2.XX.XX",
			"InstanceId": "i-m5ehn8ugwvsp2k4x****",
			"IntranetIp": "1.2.XX.XX"
		},
		{
			"AssetType": 2,
			"Uuid": "eip-wz9***",
			"InternetIp": "1.2.XX.XX",
			"InstanceId": "eip-wz9***"
		},
		{
			"InstanceName": "abc",
			"AssetType": 1,
			"Uuid": "lb-bp***",
			"InternetIp": "1.2.XX.XX",
			"InstanceId": "lb-bp***"
		}
	],
	"Domain": "example.com",
	"RequestId": "3A85CFCF-05C8-451A-9E41-C0D5E96BA407",
	"RootDomain": "example.com",
	"VulCount": 0,
	"AlarmCount": 0
}

Error codes

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