调用ScrollDomainList翻页遍历域名列表。
接口说明
针对域名持有数量较大的用户,查询域名列表接口响应可能存在缓慢的情况,阿里云提供了翻页遍历域名列表的功能。该接口在第一次调用时,需要传入查询条件,但不要传入scrollId,此时接口会返回scrollId,并不返回数据。第二次查询开始,需要传入上一次请求获取的scrollId,并且后续查询中传入的查询条件将不会生效,需以第一次请求时的查询条件为准。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
domain:QueryCommonInfo | List |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
RequestId | string |
唯一请求识别码。 |
722AB7F5-61F0-408C-A012-4784AFD34083 |
PageSize | integer |
分页大小。 |
50 |
ScrollId | string |
翻页遍历ID。 |
test |
Data | object [] |
域名列表。 |
|
DomainAuditStatus | string |
域名实名认证状态。取值:
|
NONAUDIT |
DomainGroupId | string |
域名分组编号。 |
1234 |
Remark | string |
域名备注。 |
测试域名 |
DomainGroupName | string |
域名分组名称。 |
测试分组 |
ZhRegistrantOrganization | string |
中文域名持有者。 |
阿里云 |
RegistrantOrganization | string |
域名持有者。 |
alibaba cloud |
RegistrationDate | string |
注册时间。 |
2017-02-15 00:00:00 |
InstanceId | string |
域名实例编号。 |
S1234 |
DomainName | string |
域名。 |
example.com |
ExpirationDateStatus | string |
域名过期状态。取值:
|
1 |
ExpirationDate | string |
域名到期日。 |
2019-02-15 17:30:35 |
DnsList | array |
dns列表。 |
|
string |
DNS列表。 |
[“dns15.hichina.com”, “dns16.hichina.com”] | |
string |
邮箱。 |
username@example.com | |
RegistrantType | string |
域名注册类型。取值:
|
1 |
ExpirationDateLong | long |
域名到期日,UTC时间1970年1月1日0点距离域名到期日的毫秒数。 |
1550223035000 |
ExpirationCurrDateDiff | integer |
到期日和当前日期差。 |
10 |
Premium | boolean |
是否是溢价词。 |
false |
RegistrationDateLong | long |
域名注册时间,计算方式为UTC时间1970年1月1日0点距离注册时间的毫秒数。 |
1487088000000 |
ProductId | string |
产品ID。 |
2a |
DomainStatus | string |
域名状态。取值:
|
3 |
DomainType | string |
域名类型。取值:
|
gTLD |
ResourceGroupId | string |
资源组id。 |
rg-aek2yyciz557g3q |
Tag | object [] |
资源标签。 |
|
Key | string |
标签键。 |
testKey |
Value | string |
标签值。 |
testValue |
TotalItemNum | integer |
剩余总数。 |
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-06 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
本文来自投稿,不代表新手站长_郑州云淘科技有限公司立场,如若转载,请注明出处:https://www.cnzhanzhang.com/5162.html