文档

ScrollDomainList - 翻页遍历域名列表

更新时间:

调用ScrollDomainList翻页遍历域名列表。

接口说明

针对域名持有数量较大的用户,查询域名列表接口响应可能存在缓慢的情况,阿里云提供了翻页遍历域名列表的功能。该接口在第一次调用时,需要传入查询条件,但不要传入 scrollId,此时接口会返回 scrollId,并不返回数据。第二次查询开始,需要传入上一次请求获取的 scrollId,并且后续查询中传入的查询条件将不会生效,需以第一次请求时的查询条件为准。

调试

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

授权信息

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

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

请求参数

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

查询域名到期日期范围的结束时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。

1541520000000
UserClientIpstring

用户 IP,可设置为127.0.0.1

127.0.0.1
Langstring

接口返回错误信息语言。取值:

  • zh:中文。
  • en:英文。

默认为 en

en
StartExpirationDatelong

查询域名到期日期范围的开始时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。

1541520000000
ProductDomainTypestring

域名类型。取值:

  • New gTLD
  • gTLD
  • ccTLD
  • other
gTLD
PageSizeinteger

域名列表的分页大小。

50
DomainGroupIdlong

域名分组 ID,可通过 QueryDomainGroupList 接口获取。

123456
DomainStatusinteger

域名状态。取值:

  • 0:全部。
  • 1:急需续费。
  • 2:急需赎回。
  • 3:正常。
  • 4:正在转出万网。
  • 5:域名持有者信息修改中。
  • 6:未实名认证。
  • 7:审核失败,重新实名认证。
  • 8:审核中。
0
EndLengthinteger

查询域名长度范围的结束长度。

3
Excludedstring

排除关键字。

test
ExcludedPrefixboolean

开头排除关键字。

false
ExcludedSuffixboolean

结束排除关键字。

true
Forminteger

域名组成信息。

1
KeyWordstring

关键字。

test
KeyWordPrefixboolean

开头关键字。

true
KeyWordSuffixboolean

结束关键字。

false
StartLengthinteger

查询域名长度范围的开始长度。

0
TradeTypeinteger

发布状态。取值:

  • 2:已发布一口价。
  • 3:已发布线上议价。
  • 4:已发布竞价。
  • 6:已发布带价 push。
  • -1:未发布域名交易。
-1
Suffixsstring

查询后缀列表,以逗号(,)隔开。

com
StartRegistrationDatelong

查询域名注册日期范围的开始时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。

1541520000000
EndRegistrationDatelong

查询域名注册日期范围的结束时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。

1541520000000
ScrollIdstring

翻页遍历 ID(技术参数)。

test
ResourceGroupIdstring

资源组 id。

rg-acfmw6bpc6n7zai

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

722AB7F5-61F0-408C-A012-4784AFD34083
PageSizeinteger

分页大小。

50
ScrollIdstring

翻页遍历 ID。

test
Dataobject []

域名列表。

DomainAuditStatusstring

域名实名认证状态。取值:

  • FAILED:实名认证失败。
  • SUCCEED:实名认证成功。
  • NONAUDIT:未实名认证。
  • AUDITING:审核中。
NONAUDIT
DomainGroupIdstring

域名分组编号。

1234
Remarkstring

域名备注。

测试域名
DomainGroupNamestring

域名分组名称。

测试分组
ZhRegistrantOrganizationstring

中文域名持有者。

阿里云
RegistrantOrganizationstring

域名持有者。

alibaba cloud
RegistrationDatestring

注册时间。

2017-02-15 00:00:00
InstanceIdstring

域名实例编号。

S1234
DomainNamestring

域名。

example.com
ExpirationDateStatusstring

域名过期状态。取值:

  • 1:域名未过期。
  • 2:域名已过期。
1
ExpirationDatestring

域名到期日。

2019-02-15 17:30:35
DnsListarray

dns 列表。

string

DNS 列表。

["dns15.hichina.com", "dns16.hichina.com"]
Emailstring

邮箱。

username@example.com
RegistrantTypestring

域名注册类型。取值:

  • 1:个人。
  • 2:企业。
1
ExpirationDateLonglong

域名到期日,UTC 时间 1970 年 1 月 1 日 0 点距离域名到期日的毫秒数。

1550223035000
ExpirationCurrDateDiffinteger

到期日和当前日期差。

10
Premiumboolean

是否是溢价词。

false
RegistrationDateLonglong

域名注册时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离注册时间的毫秒数。

1487088000000
ProductIdstring

产品 ID。

2a
DomainStatusstring

域名状态。取值:

  • 1:急需续费。
  • 2:急需赎回。
  • 3:正常。
  • 4:转出中。
  • 5:域名持有者信息修改中。
  • 6:未实名认证。
  • 7:实名认证失败。
  • 8:实名认证审核中。
3
DomainTypestring

域名类型。取值:

  • New gTLD
  • gTLD
  • ccTLD
gTLD
ResourceGroupIdstring

资源组 id。

rg-aek2yyciz557g3q
Tagobject []

资源标签。

Keystring

标签键。

testKey
Valuestring

标签值。

testValue
TotalItemNuminteger

剩余总数。

200

示例

正常返回示例

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