All Products
Search
Document Center

Security Center:DescribeDomainDetail

更新時間:Nov 13, 2024

Queries the details of domain assets within your Alibaba Cloud account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeDomainDetailget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

1.2.XX.XX
DomainNamestringYes

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

Response parameters

ParameterTypeDescriptionExample
object
Domainstring

The domain name.

example.com
RequestIdstring

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

3A85CFCF-05C8-451A-9E41-C0D5E96BA407
VulCountinteger

The total number of vulnerabilities in your website assets.

2
AlarmCountinteger

The total number of alerts in your website assets.

2
RootDomainstring

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

example.com
DomainDetailItemsarray<object>

An array that consists of the details about the domain asset.

DomainDetailItemobject
Uuidstring

The instance UUID of the domain asset.

lb-bp1g9dohoyin9cjhn6****
InternetIpstring

The public IP address of the asset.

1.2.XX.XX
InstanceNamestring

The name of the asset.

iZm5e6w7dzsktt6mz4yimeZ-6****
InstanceIdstring

The instance ID of the asset.

i-m5e6w7dzsktt6mz4***
IntranetIpstring

The private IP address of the asset.

1.2.XX.XX
AssetTypestring

The type of the domain asset. Valid values:

  • 0: an Elastic Compute Service (ECS) instance
  • 1: a Server Load Balancer (SLB) instance
  • 2: a Network Address Translation (NAT) gateway
  • 3: an ApsaraDB RDS instance
  • 4: an ApsaraDB for MongoDB instance
0

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400DataExists%s data exist-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details