调用DescribeSubDomainRecords根据传入参数获取某个固定子域名的所有解析记录列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSubDomainRecords |
系统规定参数。取值:DescribeSubDomainRecords。 |
Lang | String | 否 | en |
语言。 |
UserClientIp | String | 否 | 192.0.2.0 |
用户端IP。 |
SubDomain | String | 是 | a.www.example.com |
以参数SubDomain为a.www.example.com为示例: 如果参数DomainName为空,则查询域名为example.com、主机名为”a.www“的解析记录。 如果参数DomainName为 www.example.com,则查询域名为www.example.com、主机名为 "a"的解析记录。 如果参数DomainName为 a.www.example.com,则查询域名为a.www.example.com、主机名为 "@"的解析记录。 |
PageNumber | Long | 否 | 1 |
当前页数,起始值为1,默认为1。 |
PageSize | Long | 否 | 20 |
分页查询时设置的每页行数,最大值500,默认为20。 |
Type | String | 否 | MX |
解析记录类型。若不传值,则返回子域名对应的全部解析记录类型。 解析类型包括(不区分大小写):A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV。 |
Line | String | 否 | default |
解析线路。 |
DomainName | String | 否 | example.com |
域名名称。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Long | 2 |
解析记录总数。 |
PageSize | Long | 2 |
本次查询获取的解析数量。 |
RequestId | String | 536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
请求ID。 |
DomainRecords | Array of Record |
解析记录列表。 |
|
Record | |||
Status | String | Enable |
解析记录状态 |
Type | String | CNAME |
记录类型 |
Weight | Integer | 10 |
解析记录的权重 |
Value | String | example.net |
记录值 |
TTL | Long | 600 |
生存时间 |
Line | String | default |
解析线路 |
RecordId | String | 9999985 |
解析记录ID |
Priority | Long | 2 |
MX记录的优先级 |
RR | String | www |
主机记录 |
DomainName | String | example.com |
域名名称 |
Locked | Boolean | false |
解析记录锁定状态 |
Remark | String | 这是备注 |
备注信息 |
PageNumber | Long | 1 |
当前页码。 |
示例
请求示例
http(s)://alidns.aliyuncs.com/?Action=DescribeSubDomainRecords
&Lang=en
&UserClientIp=192.0.2.0
&SubDomain=a.www.example.com
&PageNumber=1
&PageSize=20
&Type=MX
&Line=default
&DomainName=example.com
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeSubDomainRecordsResponse>
<TotalCount>2</TotalCount>
<PageSize>2</PageSize>
<RequestId>536E9CAD-DB30-4647-AC87-AA5CC38C5382</RequestId>
<DomainRecords>
<Status>Enable</Status>
<Type>CNAME</Type>
<Weight>10</Weight>
<Value>example.net</Value>
<TTL>600</TTL>
<Line>default</Line>
<RecordId>9999985</RecordId>
<Priority>2</Priority>
<RR>www</RR>
<DomainName>example.com</DomainName>
<Locked>false</Locked>
</DomainRecords>
<PageNumber>1</PageNumber>
</DescribeSubDomainRecordsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 2,
"PageSize" : 2,
"RequestId" : "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"DomainRecords" : [ {
"Status" : "Enable",
"Type" : "CNAME",
"Weight" : 10,
"Value" : "example.net",
"TTL" : 600,
"Line" : "default",
"RecordId" : "9999985",
"Priority" : 2,
"RR" : "www",
"DomainName" : "example.com",
"Locked" : false
} ],
"PageNumber" : 1
}
错误码
访问错误中心查看更多错误码。