DescribeDomainDetail API Reference for Domain Assets - Security Center - Alibaba Cloud - Security Center

Queries the details of your domain name assets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeDomainDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	1.2.XX.XX
DomainName	string	Yes	The name of the domain name or website to query. Note Fuzzy match is not supported. Enter the complete domain name or website name.	example.com

Response elements

Element	Type	Description	Example
	object
Domain	string	The domain name.	example.com
RequestId	string	The request ID. The China value is a unique identifier that Alibaba Cloud generates for the request. You can use this ID to troubleshoot issues.	3A85CFCF-05C8-451A-9E41-C0D5E96BA407
VulCount	integer	The total number of vulnerabilities in your website assets.	2
AlarmCount	integer	The total number of alerts in your website assets.	2
RootDomain	string	The root domain name that corresponds to the domain name.	example.com
DomainDetailItems	array<object>	The asset information related to the domain name.
	object
Uuid	string	The UUID of the asset instance.	lb-bp1g9dohoyin9cjhn6****
InternetIp	string	The public IP address of the asset.	1.2.XX.XX
InstanceName	string	The name of the asset.	iZm5e6w7dzsktt6mz4yimeZ-6****
InstanceId	string	The instance ID of the asset.	i-m5e6w7dzsktt6mz4***
IntranetIp	string	The private IP address of the asset.	1.2.XX.XX
AssetType	string	The Asset Type of the asset under the domain name. Valid values: 0: ECS 1: load balancing 2: NAT gateway 3: RDS database 4: MongoDB database	0

Examples

Success response

JSON format

{
  "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
400	DataExists	%s data exist
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.