根據傳入參數查詢該使用者的網域名稱列表。
介面說明
可以指定頁碼(PageNumber)和每頁的數量(PageSize)來擷取網域名稱列表。
可以指定網域名稱的關鍵字(KeyWord)來查詢含有該關鍵字的網域名稱列表。
網域名稱列表的預設排序方式是按照網域名稱添加的時間從新到舊排序的。
可以指定網域名稱分組的 ID(GroupId),全部網域名稱代表所有網域名稱、預設分組代表未設定分組的網域名稱。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
alidns:DescribeDomains |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Lang |
string |
否 |
傳回值語言,取值:
預設:zh |
en |
| KeyWord |
string |
否 |
關鍵字,按照“%KeyWord%”模式搜尋,不區分大小寫。 |
com |
| GroupId |
string |
否 |
指網域名稱分組 ID。 如不填或傳Null 字元,將在全部網域名稱下查詢。 如傳 defaultGroup,將在預設分組下查詢。 |
defaultGroup |
| PageNumber |
integer |
否 |
當前頁數,起始值為 1,預設為 1。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時設定的每頁行數,最大值 100,預設為 20。 |
20 |
| SearchMode |
string |
否 |
搜尋模式。取值:
預設:LIKE |
LIKE |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-re******** |
| Starmark |
boolean |
否 |
是否查詢網域名稱星標。取值:
預設:true |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Domains |
object |
||
| Domain |
array<object> |
本次擷取的網域名稱列表。 |
|
|
object |
本次擷取的網域名稱列表。 |
||
| Remark |
string |
備忘。 |
remark |
| CreateTime |
string |
網域名稱添加時間。 |
2019-01-30T05:25Z |
| RecordCount |
integer |
網域名稱含有的解析記錄條數。 |
100 |
| Tags |
object |
||
| Tag |
array<object> |
標籤索引值對數組。 |
|
|
object |
|||
| Key |
string |
標籤鍵。 |
測試標籤 |
| Value |
string |
標籤值。 |
測試標籤值 |
| InstanceId |
string |
雲解析產品識別碼。 |
i-*** |
| DomainName |
string |
網域名稱名稱。 |
example.com |
| DomainId |
string |
網域名稱 ID。 |
00efd71a-770e-4255-********* |
| AliDomain |
boolean |
是否為阿里雲萬網網域名稱。 |
true |
| GroupId |
string |
網域名稱分組 ID。 |
2*** |
| GroupName |
string |
網域名稱分組名稱。 |
mygroup |
| ResourceGroupId |
string |
所屬資源群組 ID。 |
rg*** |
| InstanceEndTime |
string |
執行個體的到期時間。 |
2020-03-14T16:00Z |
| InstanceExpired |
boolean |
執行個體是否到期。 |
false |
| VersionName |
string |
雲解析產品名稱。 |
企業旗艦版 |
| DnsServers |
object |
||
| DnsServer |
array |
雲解析系統分配的 DNS 伺服器名稱列表。 |
|
|
string |
雲解析系統分配的 DNS 伺服器名稱。 |
{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]} |
|
| VersionCode |
string |
雲解析版本 Code。 |
version_enterprise_basic |
| PunyCode |
string |
中文網域名稱的 punycode 碼,英文網域名稱返回為空白。 |
example.com |
| RegistrantEmail |
string |
註冊人郵箱。 |
****@example.com |
| CreateTimestamp |
integer |
添加時間(時間戳記)。 |
1660546144000 |
| Starmark |
boolean |
是否收藏至常用網域名稱列表。 |
true |
| DomainLoggingSwitchStatus |
string |
網域名稱 DNS 流量分析開啟狀態:
|
OPEN |
| SlaveDnsStatus |
string |
||
| TotalCount |
integer |
網域名稱列表總數。 |
2 |
| PageSize |
integer |
分頁查詢時設定的每頁行數,最大值 100,預設為 20。 |
2 |
| RequestId |
string |
唯一請求識別碼。 |
68386699-8B9E-4D5B-BC4C-75A28F6C2A00 |
| PageNumber |
integer |
當前頁數,起始值為 1,預設為 1。 |
1 |
樣本
正常返回樣本
JSON格式
{
"Domains": {
"Domain": [
{
"Remark": "remark",
"CreateTime": "2019-01-30T05:25Z",
"RecordCount": 100,
"Tags": {
"Tag": [
{
"Key": "測試標籤",
"Value": "測試標籤值"
}
]
},
"InstanceId": "i-***",
"DomainName": "example.com\n",
"DomainId": "00efd71a-770e-4255-*********",
"AliDomain": true,
"GroupId": "2***",
"GroupName": "mygroup",
"ResourceGroupId": "rg***",
"InstanceEndTime": "2020-03-14T16:00Z",
"InstanceExpired": false,
"VersionName": "企業旗艦版",
"DnsServers": {
"DnsServer": [
"{\"DnsServer\": [\"ns1.alidns.com\",\"ns2.alidns.com\"]}"
]
},
"VersionCode": "version_enterprise_basic",
"PunyCode": "example.com\n",
"RegistrantEmail": "****@example.com",
"CreateTimestamp": 1660546144000,
"Starmark": true,
"DomainLoggingSwitchStatus": "OPEN",
"SlaveDnsStatus": ""
}
]
},
"TotalCount": 2,
"PageSize": 2,
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"PageNumber": 1
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。