调用DescribeDomainDetail接口查询域名资产的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDomainDetail

要执行的操作。取值:DescribeDomainDetail

SourceIp String 1.2.XX.XX

访问源的IP地址。

DomainName String example.com

要查询的域名或网站的名称。

说明 不支持模糊查询,您需要输入完整的域名或网站名称。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Domain String example.com

域名。

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

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

VulCount Integer 2

您网站资产中的漏洞的总数量。

AlarmCount Integer 2

您网站资产中的告警的总数量。

RootDomain String tst.com

域名对应的根域名的名称。

DomainDetailItems Array of DomainDetailItem

域名相关的资产信息。

Uuid String lb-bp1g9dohoyin9cjhn6****

资产实例的UUID。

InternetIp String 1.2.XX.XX

资产对应的公网的IP地址。

InstanceName String iZm5e6w7dzsktt6mz4yimeZ-6****

资产的名称。

InstanceId String i-m5e6w7dzsktt6mz4***

资产的实例ID。

IntranetIp String 1.2.XX.XX

资产对应的私网的IP地址。

AssetType String 0

域名下资产的资产类型。取值包括:

  • 0:ECS
  • 1:负载均衡
  • 2:NAT网关
  • 3:RDS数据库
  • 4:MongoDB数据库

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomainDetail
&SourceIp=1.2.XX.XX
&DomainName=example.com
&公共请求参数

正常返回示例

XML格式

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>tst.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格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 DataExists %s data exist 数据已存在
500 ServerError ServerError 服务故障

访问错误中心查看更多错误码。