文档

DescribeDomainInfo - 获取域名信息

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

用户语言。

en
DomainNamestring

域名名称。

dns-example.com
NeedDetailAttributesboolean

默认值为 false,表示不需要细节属性。

当值为 true 时,则返回以下数据:lineType、minTtl、recordLineTreeJson、recordLines、lineCode、lineDisplayName、lineName、regionLines、slaveDns。

true

返回参数

名称类型描述示例值
object
RecordLineTreeJsonstring

树形化解析请求来源线路列表。

{"default":{},"unicom":{},"telecom":{},"mobile":{},"edu":{},"oversea":{},"baidu":{},"biying":{},"google":{}}
GroupNamestring

域名分组名称。

mygroup
InBlackHoleboolean

是否在黑洞中。

false
RegionLinesboolean

是否是地域线路。

false
SlaveDnsboolean

是否允许有辅助 dns。

true
AliDomainboolean

是否为阿里云万网域名。

true
RequestIdstring

唯一请求识别码。

536E9CAD-DB30-4647-AC87-AA5CC38C5382
ResourceGroupIdstring

资源组 ID。

rg-aek3dj3wvclgcxo
InstanceIdstring

云解析产品 ID。

i-7bg
DomainNamestring

域名名称。

example.com
CreateTimestring

创建时间。

2015-12-12T09:23Z
PunyCodestring

只针对中文域名返回 punycode 码。

example.com
DnsServersarray

域名在解析系统中的 DNS 列表

string

DNS 信息。

["vip3.alidns.com", "vip4.alidns.com"]
Remarkstring

备注。

remark
GroupIdstring

域名分组 ID。

2223
VersionCodestring

云解析版本 ID。

version1
RecordLinesobject []

解析请求来源线路数据列表。

FatherCodestring

父线路 Code,如果没有则为空。

internal
LineDisplayNamestring

父线路展示名。

中国地区_西北
LineCodestring

子线路 Code。

cn_region_xibei
LineNamestring

子线路展示名。

西北
DomainIdstring

域名 ID。

00efd71a-770e-4255-b54e-6fe5659baffe
AvailableTtlsarray

域名当前可用 TTL 列表。默认不返回,需要设置 NeedDetailAttributes=true。

string

可用 TTL 列表。

[600,1800,3600,43200,86400]
MinTtllong

最小 TTL。

1
InCleanboolean

是否在清洗中。

false
VersionNamestring

云解析产品名称。

企业旗舰版
LineTypestring

解析请求来源线路类型。

region_province
SubDomainboolean

查询的 domain 是否是托管的子域名。 取值:

  • true
  • false
false
DomainLoggingSwitchStatusstring

日志开关状态

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-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)