文档

QueryDomainList - 分页查询自己账户下的域名列表

更新时间:

分页查询自己账户下的域名列表。

调试

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

授权信息

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

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

请求参数

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

查询域名到期日期的结束时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数,目前仅支持按天查询。

1522080000000
StartExpirationDatelong

查询域名到期日期的开始时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数,目前仅支持按天查询。

1522080000000
UserClientIpstring

用户 IP,可以设置为127.0.0.1

127.0.0.1
Langstring

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

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

默认值为 en

en
QueryTypestring

列表查询类型。取值:

  • 1:急需续费列表。
  • 2:急需赎回列表。
1
StartRegistrationDatelong

查询域名注册日期的开始时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数,目前仅支持按天查询。

1522080000000
EndRegistrationDatelong

查询域名注册日期的结束时间,计算方式为 UTC 时间 1970 年 1 月 1 日 0 点距离现在的毫秒数,目前仅支持按天查询。

1522080000000
DomainNamestring

域名搜索,可在域名列表中搜索该域名。

test.com
OrderByTypestring

业务内容(如注册时间、过期时间)的排序顺序。取值:

  • ASC:升序。
  • DESC:倒序。
说明 不传此参数默认为 DESC
ASC
OrderKeyTypestring

排序字段。取值:

  • RegistrationDate:根据注册时间排序。
  • ExpirationDate:根据到期时间排序。
说明 不传此参数时,默认以入库时间排序。
RegistrationDate
ProductDomainTypestring

域名类型。取值:

  • New gTLD:新顶级域。
  • gTLD:通用顶级域。
  • ccTLD:国别域。
New gTLD
PageNuminteger

域名列表的分页页码。

1
PageSizeinteger

域名列表的分页大小。

10
DomainGroupIdstring

域名分组 ID,可使用查询域名分组的 QueryDomainGroupList 接口获取。

123456
ResourceGroupIdstring

资源组 id。

rg-aek2indvyxgpfti
Tagobject []

标签列表

Keystring

标签键。

备注
Valuestring

标签值。

标签1

返回参数

名称类型描述示例值
object
PrePageboolean

是否有上一页。

false
CurrentPageNuminteger

当前域名列表的分页页码。

0
RequestIdstring

唯一请求识别码。

B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E
PageSizeinteger

域名分页列表的大小。

5
TotalPageNuminteger

域名列表的总页数。

1
Dataobject []

域名列表。

DomainAuditStatusstring

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

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

域名分组编号。

123456
Remarkstring

域名备注。

测试备注
DomainGroupNamestring

域名分组名称

测试分组
RegistrationDatestring

注册时间。

2017-11-02 04:00:45
InstanceIdstring

实例编号。

ST20151102120031118
DomainNamestring

域名。

test.com
ExpirationDateStatusstring

域名过期状态。取值:

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

域名到期日期。

2017-11-02 04:00:45
RegistrantTypestring

域名注册类型。取值:

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

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

1522080000000
ExpirationCurrDateDiffinteger

域名到期日和当前的时间的天数差值。

-30
Premiumboolean

是否是溢价域名。

true
RegistrationDateLonglong

注册时长,UTC 时间 1970 年 1 月 1 日 0 点距离注册时间的毫秒数。

1522080000000
ProductIdstring

产品 ID。

2a
DomainStatusstring

域名状态。取值:

  • 1:急需续费。
  • 2:急需赎回。
  • 3:正常。
3
DomainTypestring

域名类型。取值:

  • New gTLD
  • gTLD
  • ccTLD
gTLD
ResourceGroupIdstring

域名资源组 id。

rg-aek2yyciz557g3q
Tagobject []

域名标签列表。

Keystring

标签键。

费用
Valuestring

标签的值。

标签1
TotalItemNuminteger

域名总数。

1
NextPageboolean

是否有下一页。

false

示例

正常返回示例

JSON格式

{
  "PrePage": false,
  "CurrentPageNum": 0,
  "RequestId": "B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E",
  "PageSize": 5,
  "TotalPageNum": 1,
  "Data": {
    "Domain": [
      {
        "DomainAuditStatus": "FAILED",
        "DomainGroupId": "123456",
        "Remark": "测试备注",
        "DomainGroupName": "测试分组",
        "RegistrationDate": "2017-11-02 04:00:45",
        "InstanceId": "ST20151102120031118",
        "DomainName": "test.com",
        "ExpirationDateStatus": "1",
        "ExpirationDate": "2017-11-02 04:00:45",
        "RegistrantType": "1",
        "ExpirationDateLong": 1522080000000,
        "ExpirationCurrDateDiff": -30,
        "Premium": true,
        "RegistrationDateLong": 1522080000000,
        "ProductId": "2a",
        "DomainStatus": "3",
        "DomainType": "gTLD",
        "ResourceGroupId": "rg-aek2yyciz557g3q",
        "Tag": {
          "Tag": [
            {
              "Key": "费用",
              "Value": "标签1"
            }
          ]
        },
        "Ccompany": ""
      }
    ]
  },
  "TotalItemNum": 1,
  "NextPage": false
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Ccompany
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈