调用ScrollDomainList翻页遍历域名列表。
接口说明
针对域名持有数量较大的用户，查询域名列表接口响应可能存在缓慢的情况，阿里云提供了翻页遍历域名列表的功能。该接口在第一次调用时，需要传入查询条件，但不要传入 scrollId，此时接口会返回 scrollId，并不返回数据。第二次查询开始，需要传入上一次请求获取的 scrollId，并且后续查询中传入的查询条件将不会生效，需以第一次请求时的查询条件为准。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
domain:QueryCommonInfo |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EndExpirationDate |
integer |
否 |
查询域名到期日期范围的结束时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。 |
1541520000000 |
| UserClientIp |
string |
否 |
用户 IP，可设置为127.0.0.1。 |
127.0.0.1 |
| Lang |
string |
否 |
接口返回错误信息语言。取值：
默认为 en。 |
en |
| StartExpirationDate |
integer |
否 |
查询域名到期日期范围的开始时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。 |
1541520000000 |
| ProductDomainType |
string |
否 |
域名类型。取值：
|
gTLD |
| PageSize |
integer |
否 |
域名列表的分页大小。 |
50 |
| DomainGroupId |
integer |
否 |
域名分组 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 |
integer |
否 |
查询域名注册日期范围的开始时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。 |
1541520000000 |
| EndRegistrationDate |
integer |
否 |
查询域名注册日期范围的结束时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。 |
1541520000000 |
| ScrollId |
string |
否 |
翻页遍历 ID（技术参数）。 |
test |
| ResourceGroupId |
string |
否 |
资源组 id。 |
rg-acfmw6bpc6n7zai |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Data |
object |
||
| Domain |
array<object> |
域名列表。 |
|
|
array<object> |
域名列表。 |
||
| DnsList |
object |
||
| Dns |
array |
dns 列表。 |
|
|
string |
DNS 列表。 |
["dns15.hichina.com", "dns16.hichina.com"] |
|
| DomainAuditStatus |
string |
域名实名认证状态。取值：
|
NONAUDIT |
| DomainGroupId |
string |
域名分组编号。 |
1234 |
| DomainGroupName |
string |
域名分组名称。 |
测试分组 |
| DomainName |
string |
域名。 |
example.com |
| DomainStatus |
string |
域名状态。取值：
|
3 |
| DomainType |
string |
域名类型。取值：
|
gTLD |
|
string |
邮箱。 |
username@example.com |
|
| ExpirationCurrDateDiff |
integer |
到期日和当前日期差。 |
10 |
| ExpirationDate |
string |
域名到期日。 |
2019-02-15 17:30:35 |
| ExpirationDateLong |
integer |
域名到期日，UTC 时间 1970 年 1 月 1 日 0 点距离域名到期日的毫秒数。 |
1550223035000 |
| ExpirationDateStatus |
string |
域名过期状态。取值：
|
1 |
| InstanceId |
string |
域名实例编号。 |
S1234 |
| Premium |
boolean |
是否是溢价词。 |
false |
| ProductId |
string |
产品 ID。 |
2a |
| RegistrantOrganization |
string |
域名持有者。 |
alibaba cloud |
| RegistrantType |
string |
域名注册类型。取值：
|
1 |
| RegistrationDate |
string |
注册时间。 |
2017-02-15 00:00:00 |
| RegistrationDateLong |
integer |
域名注册时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离注册时间的毫秒数。 |
1487088000000 |
| Remark |
string |
域名备注。 |
测试域名 |
| ResourceGroupId |
string |
资源组 id。 |
rg-aek2yyciz557g3q |
| Tag |
object |
||
| Tag |
array<object> |
资源标签。 |
|
|
object |
|||
| Key |
string |
标签键。 |
testKey |
| Value |
string |
标签值。 |
testValue |
| ZhRegistrantOrganization |
string |
中文域名持有者。 |
阿里云 |
| PageSize |
integer |
分页大小。 |
50 |
| RequestId |
string |
唯一请求识别码。 |
722AB7F5-61F0-408C-A012-4784AFD34083 |
| ScrollId |
string |
翻页遍历 ID。 |
test |
| TotalItemNum |
integer |
剩余总数。 |
200 |
示例
正常返回示例
JSON格式
{
"Data": {
"Domain": [
{
"DnsList": {
"Dns": [
"[\"dns15.hichina.com\", \"dns16.hichina.com\"]"
]
},
"DomainAuditStatus": "NONAUDIT",
"DomainGroupId": "1234",
"DomainGroupName": "测试分组",
"DomainName": "example.com",
"DomainStatus": "3",
"DomainType": "gTLD",
"Email": "username@example.com",
"ExpirationCurrDateDiff": 10,
"ExpirationDate": "2019-02-15 17:30:35",
"ExpirationDateLong": 1550223035000,
"ExpirationDateStatus": "1",
"InstanceId": "S1234",
"Premium": false,
"ProductId": "2a",
"RegistrantOrganization": "alibaba cloud",
"RegistrantType": "1",
"RegistrationDate": "2017-02-15 00:00:00",
"RegistrationDateLong": 1487088000000,
"Remark": "测试域名",
"ResourceGroupId": "rg-aek2yyciz557g3q",
"Tag": {
"Tag": [
{
"Key": "testKey",
"Value": "testValue"
}
]
},
"ZhRegistrantOrganization": "阿里云"
}
]
},
"PageSize": 50,
"RequestId": "722AB7F5-61F0-408C-A012-4784AFD34083",
"ScrollId": "test",
"TotalItemNum": 200
}异常返回示例
JSON格式
{
"Data":{
"Domain":[
{
"DnsList":{
"Dns":[
"dns15.hichina.com",
"dns16.hichina.com"
]
},
"DomainAuditStatus":"FAILED",
"DomainGroupId":"-1",
"DomainGroupName":"未分组",
"DomainName":"test.com",
"DomainStatus":"7",
"DomainType":"gTLD",
"Email":"test@a.com",
"ExpirationCurrDateDiff":85,
"ExpirationDate":"2019-02-15 17:30:35",
"ExpirationDateLong":1550223035000,
"ExpirationDateStatus":"1",
"InstanceId":"S2017000000",
"Premium":false,
"ProductId":"2a",
"RegistrantOrganization":"Test",
"RegistrantType":"1",
"RegistrationDate":"2017-02-15 00:00:00",
"RegistrationDateLong":1487088000000,
"Remark":"备注",
"ZhRegistrantOrganization":"测试"
},
{
"DnsList":{
"Dns":[
"dns11.hichina.com",
"dns12.hichina.com"
]
},
"DomainAuditStatus":"SUCCEED",
"DomainGroupId":"-1",
"DomainGroupName":"未分组",
"DomainName":"test1.com",
"DomainStatus":"3",
"DomainType":"gTLD",
"Email":"test@a.com",
"ExpirationCurrDateDiff":181,
"ExpirationDate":"2019-05-22 16:23:19",
"ExpirationDateLong":1558513399000,
"ExpirationDateStatus":"1",
"InstanceId":"S2000000000000",
"Premium":false,
"ProductId":"2a",
"RegistrantOrganization":"test",
"RegistrantType":"1",
"RegistrationDate":"2018-05-22 16:23:19",
"RegistrationDateLong":1526977399000,
"Remark":"备注",
"ZhRegistrantOrganization":"测试"
}
]
},
"PageSize":2,
"RequestId":"9012EED7-4B99-4BC3-B04F-4BA637A90DC7",
"ScrollId":"eJxlUk2P2yAQ",
"TotalItemNum":539
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。