Queries the details about 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.

SourceIp String No 1.2.XX.XX

The source IP address of the request.

DomainName String Yes example.com

The domain name or the name of website that you want to query.

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

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
Domain String example.com

The domain name.

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

The ID of the request, which is used to locate and troubleshoot issues.

VulCount Integer 2

The total number of vulnerabilities in your website assets.

AlarmCount Integer 2

The total number of alerts in your website assets.

RootDomain String example.com

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

DomainDetailItems Array of DomainDetailItem

The details about the domain asset.

Uuid String lb-bp1g9dohoyin9cjhn6****

The UUID of the asset instance.

InternetIp String 1.2.XX.XX

The public IP address of the asset.

InstanceName String iZm5e6w7dzsktt6mz4yimeZ-6****

The name of the asset.

InstanceId String i-m5e6w7dzsktt6mz4***

The ID of the asset instance.

IntranetIp String 1.2.XX.XX

The private IP address of the 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
  • 3: ApsaraDB RDS instance
  • 4: ApsaraDB for MongoDB instance

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDomainDetail
&SourceIp=1.2.XX.XX
&DomainName=example.com
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainDetailResponse>
    <Domain>example.com</Domain>
    <RequestId>3A85CFCF-05C8-451A-9E41-C0D5E96BA407</RequestId>
    <VulCount>2</VulCount>
    <AlarmCount>2</AlarmCount>
    <RootDomain>example.com</RootDomain>
    <DomainDetailItems>
        <Uuid>lb-bp1g9dohoyin9cjhn6****</Uuid>
        <InternetIp>1.2.XX.XX</InternetIp>
        <InstanceName>iZm5e6w7dzsktt6mz4yimeZ-6****</InstanceName>
        <InstanceId>i-m5e6w7dzsktt6mz4***</InstanceId>
        <IntranetIp>1.2.XX.XX</IntranetIp>
        <AssetType>0</AssetType>
    </DomainDetailItems>
</DescribeDomainDetailResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Domain" : "example.com",
  "RequestId" : "3A85CFCF-05C8-451A-9E41-C0D5E96BA407",
  "VulCount" : 2,
  "AlarmCount" : 2,
  "RootDomain" : "example.com",
  "DomainDetailItems" : [ {
    "Uuid" : "lb-bp1g9dohoyin9cjhn6****",
    "InternetIp" : "1.2.XX.XX",
    "InstanceName" : "iZm5e6w7dzsktt6mz4yimeZ-6****",
    "InstanceId" : "i-m5e6w7dzsktt6mz4***",
    "IntranetIp" : "1.2.XX.XX",
    "AssetType" : "0"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 DataExists %s data exist The error message returned because the data already exists.
500 ServerError ServerError The error message returned because an internal error occurred.

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