DescribeDomainInfo - 获取域名信息 - 云解析 DNS

根据传入参数查询指定域名的信息。

接口说明

本示例中域名绑定的实例为企业旗舰版。线路枚举信息可以参考 RecordLines 的返回值。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alidns:DescribeDomainInfo	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	用户语言。	en
DomainName	string	是	域名名称。	dns-example.com
NeedDetailAttributes	boolean	否	默认值为 false，表示不需要细节属性。当值为 true 时，则返回以下数据：lineType、minTtl、recordLineTreeJson、recordLines、lineCode、lineDisplayName、lineName、regionLines、slaveDns。	true

返回参数

名称	类型	描述	示例值
	object
RecordLineTreeJson	string	树形化解析请求来源线路列表。	{"default":{},"unicom":{},"telecom":{},"mobile":{},"edu":{},"oversea":{},"baidu":{},"biying":{},"google":{}}
GroupName	string	域名分组名称。	mygroup
InBlackHole	boolean	是否在黑洞中。	false
RegionLines	boolean	是否是地域线路。	false
SlaveDns	boolean	是否允许有辅助 dns。	true
AliDomain	boolean	是否为阿里云万网域名。	true
RequestId	string	唯一请求识别码。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
ResourceGroupId	string	资源组 ID。	rg-aek3dj3wvclgcxo
InstanceId	string	云解析产品 ID。	i-7bg
DomainName	string	域名名称。	example.com
CreateTime	string	创建时间。	2015-12-12T09:23Z
PunyCode	string	只针对中文域名返回 punycode 码。	example.com
DnsServers	array	域名在解析系统中的 DNS 列表
DnsServer	string	DNS 信息。	["vip3.alidns.com", "vip4.alidns.com"]
Remark	string	备注。	remark
GroupId	string	域名分组 ID。	2223
VersionCode	string	云解析版本 ID。	version1
RecordLines	array<object>	解析请求来源线路数据列表。
RecordLine	object
FatherCode	string	父线路 Code，如果没有则为空。	internal
LineDisplayName	string	父线路展示名。	中国地区_西北
LineCode	string	子线路 Code。	cn_region_xibei
LineName	string	子线路展示名。	西北
DomainId	string	域名 ID。	00efd71a-770e-4255-b54e-6fe5659baffe
AvailableTtls	array	域名当前可用 TTL 列表。默认不返回，需要设置 NeedDetailAttributes=true。
AvailableTtl	string	可用 TTL 列表。	[600,1800,3600,43200,86400]
MinTtl	long	最小 TTL。	1
InClean	boolean	是否在清洗中。	false
VersionName	string	云解析产品名称。	企业旗舰版
LineType	string	解析请求来源线路类型。	region_province
SubDomain	boolean	查询的 domain 是否是托管的子域名。取值： true false	false
DomainLoggingSwitchStatus	string	日志开关状态	CLOSE：关闭状态 OPEN：开启状态

示例

正常返回示例

JSON格式

{
  "RecordLineTreeJson": "{\"default\":{},\"unicom\":{},\"telecom\":{},\"mobile\":{},\"edu\":{},\"oversea\":{},\"baidu\":{},\"biying\":{},\"google\":{}}",
  "GroupName": "mygroup",
  "InBlackHole": false,
  "RegionLines": false,
  "SlaveDns": true,
  "AliDomain": true,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "ResourceGroupId": "rg-aek3dj3wvclgcxo",
  "InstanceId": "i-7bg",
  "DomainName": "example.com",
  "CreateTime": "2015-12-12T09:23Z",
  "PunyCode": "example.com",
  "DnsServers": {
    "DnsServer": [
      "[\"vip3.alidns.com\", \"vip4.alidns.com\"]"
    ]
  },
  "Remark": "remark",
  "GroupId": "2223",
  "VersionCode": "version1",
  "RecordLines": {
    "RecordLine": [
      {
        "FatherCode": "internal",
        "LineDisplayName": "中国地区_西北",
        "LineCode": "cn_region_xibei",
        "LineName": "西北"
      }
    ]
  },
  "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  "AvailableTtls": {
    "AvailableTtl": [
      "[600,1800,3600,43200,86400]"
    ]
  },
  "MinTtl": 1,
  "InClean": false,
  "VersionName": "企业旗舰版",
  "LineType": "region_province",
  "SubDomain": false,
  "DomainLoggingSwitchStatus": "CLOSE：关闭状态\nOPEN：开启状态"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-01-17	OpenAPI 返回结构发生变更	查看变更详情
2023-09-22	OpenAPI 返回结构发生变更	查看变更详情