ScrollDomainList_域名服务_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

domain:QueryCommonInfo	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
EndExpirationDateinteger<int64>	查询域名到期日期范围的结束时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1541520000000
UserClientIpstring	用户 IP，可设置为127.0.0.1。示例值:127.0.0.1
Langstring	接口返回错误信息语言。取值：展开详情示例值:en
StartExpirationDateinteger<int64>	查询域名到期日期范围的开始时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1541520000000
ProductDomainTypestring	域名类型。取值：展开详情示例值:gTLD
PageSizeinteger<int32>	域名列表的分页大小。示例值:50取值 <= 500
DomainGroupIdinteger<int64>	域名分组 ID，可通过 QueryDomainGroupList 接口获取。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:123456参考取值来源: SaveDomainGroup QueryDomainGroupList
DomainStatusinteger<int32>	域名状态。取值：展开详情示例值:0
EndLengthinteger<int32>	查询域名长度范围的结束长度。示例值:3
Excludedstring	排除关键字。示例值:test
ExcludedPrefixboolean	开头排除关键字。示例值:false
ExcludedSuffixboolean	结束排除关键字。示例值:true
Forminteger<int32>	域名组成信息。示例值:1
KeyWordstring	关键字。示例值:test
KeyWordPrefixboolean	开头关键字。示例值:true
KeyWordSuffixboolean	结束关键字。示例值:false
StartLengthinteger<int32>	查询域名长度范围的开始长度。示例值:0
TradeTypeinteger<int32>	发布状态。取值：展开详情示例值:-1
Suffixsstring	查询后缀列表，以逗号（,）隔开。示例值:com
StartRegistrationDateinteger<int64>	查询域名注册日期范围的开始时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1541520000000
EndRegistrationDateinteger<int64>	查询域名注册日期范围的结束时间，计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1541520000000
ScrollIdstring	翻页遍历 ID（技术参数）。示例值:test
ResourceGroupIdstring	资源组 id。示例值:rg-acfmw6bpc6n7zai

返回参数

字段名称	字段详情
RequestIdstring	唯一请求识别码。示例值:722AB7F5-61F0-408C-A012-4784AFD34083
PageSizeinteger<int32>	分页大小。示例值:50
ScrollIdstring	翻页遍历 ID。示例值:test
Dataobject
TotalItemNuminteger<int32>	剩余总数。示例值:200

返回示例

错误返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-03-06	变更返回参数
	2022-12-08	新增请求参数ResourceGroupId 变更返回参数