調用ScrollDomainList翻頁遍歷域名列表。
接口說明
針對域名持有數量較大的用戶，查詢域名列表接口響應可能存在緩慢的情況，阿里云提供了翻頁遍歷域名列表的功能。該接口在第一次調用時，需要傳入查詢條件，但不要傳入 scrollId，此時接口會返回 scrollId，并不返回數據。第二次查詢開始，需要傳入上一次請求獲取的 scrollId，并且后續查詢中傳入的查詢條件將不會生效，需以第一次請求時的查詢條件為準。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| domain:QueryCommonInfo | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| EndExpirationDate | long | 否 | 查詢域名到期日期范圍的結束時間，計算方式為 UTC 時間 1970 年 1 月 1 日 0 點距離現在的毫秒數。 | 1541520000000 |
| UserClientIp | string | 否 | 用戶 IP，可設置為127.0.0.1。 | 127.0.0.1 |
| Lang | string | 否 | 接口返回錯誤信息語言。取值：
默認為 en。 | en |
| StartExpirationDate | long | 否 | 查詢域名到期日期范圍的開始時間，計算方式為 UTC 時間 1970 年 1 月 1 日 0 點距離現在的毫秒數。 | 1541520000000 |
| ProductDomainType | string | 否 | 域名類型。取值：
| gTLD |
| PageSize | integer | 是 | 域名列表的分頁大小。 | 50 |
| DomainGroupId | long | 否 | 域名分組 ID，可通過 QueryDomainGroupList 接口獲取。 | 123456 |
| DomainStatus | integer | 否 | 域名狀態。取值：
| 0 |
| EndLength | integer | 否 | 查詢域名長度范圍的結束長度。 | 3 |
| Excluded | string | 否 | 排除關鍵字。 | test |
| ExcludedPrefix | boolean | 否 | 開頭排除關鍵字。 | false |
| ExcludedSuffix | boolean | 否 | 結束排除關鍵字。 | true |
| Form | integer | 否 | 域名組成信息。 | 1 |
| KeyWord | string | 否 | 關鍵字。 | test |
| KeyWordPrefix | boolean | 否 | 開頭關鍵字。 | true |
| KeyWordSuffix | boolean | 否 | 結束關鍵字。 | false |
| StartLength | integer | 否 | 查詢域名長度范圍的開始長度。 | 0 |
| TradeType | integer | 否 | 發布狀態。取值：
| -1 |
| Suffixs | string | 否 | 查詢后綴列表，以逗號（,）隔開。 | com |
| StartRegistrationDate | long | 否 | 查詢域名注冊日期范圍的開始時間，計算方式為 UTC 時間 1970 年 1 月 1 日 0 點距離現在的毫秒數。 | 1541520000000 |
| EndRegistrationDate | long | 否 | 查詢域名注冊日期范圍的結束時間，計算方式為 UTC 時間 1970 年 1 月 1 日 0 點距離現在的毫秒數。 | 1541520000000 |
| ScrollId | string | 否 | 翻頁遍歷 ID（技術參數）。 | test |
| ResourceGroupId | string | 否 | 資源組 id。 | rg-acfmw6bpc6n7zai |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "722AB7F5-61F0-408C-A012-4784AFD34083",
"PageSize": 50,
"ScrollId": "test",
"Data": {
"Domain": [
{
"DomainAuditStatus": "NONAUDIT",
"DomainGroupId": "1234",
"Remark": "測試域名",
"DomainGroupName": "測試分組",
"ZhRegistrantOrganization": "阿里云",
"RegistrantOrganization": "alibaba cloud",
"RegistrationDate": "2017-02-15 00:00:00",
"InstanceId": "S1234",
"DomainName": "example.com",
"ExpirationDateStatus": "1",
"ExpirationDate": "2019-02-15 17:30:35",
"DnsList": {
"Dns": [
"[\"dns15.hichina.com\", \"dns16.hichina.com\"]"
]
},
"Email": "username@example.com",
"RegistrantType": "1",
"ExpirationDateLong": 1550223035000,
"ExpirationCurrDateDiff": 10,
"Premium": false,
"RegistrationDateLong": 1487088000000,
"ProductId": "2a",
"DomainStatus": "3",
"DomainType": "gTLD",
"ResourceGroupId": "rg-aek2yyciz557g3q",
"Tag": {
"Tag": [
{
"Key": "testKey",
"Value": "testValue"
}
]
}
}
]
},
"TotalItemNum": 200
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-03-06 | OpenAPI 返回結構發生變更 | 查看變更詳情 |