根據傳入參數查詢該用戶的域名列表。
接口說明
- 可以指定頁碼（PageNumber）和每頁的數量（PageSize）來獲取域名列表。
- 可以指定域名的關鍵字（KeyWord）來查詢含有該關鍵字的域名列表。
- 域名列表的默認排序方式是按照域名添加的時間從新到舊排序的。
- 可以指定域名分組的 ID（GroupId），全部域名代表所有域名、默認分組代表未設置分組的域名。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| alidns:DescribeDomains | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Lang | string | 否 | 語言。 | en |
| KeyWord | string | 否 | 關鍵字，按照“%KeyWord%”模式搜索，不區分大小寫。 | com |
| GroupId | string | 否 | 指域名分組 ID。如不填或傳空字符，將在全部域名下查詢。如傳 defaultGroup，將在默認分組下查詢。 | 2223 |
| PageNumber | long | 否 | 當前頁數，起始值為 1，默認為 1。 | 1 |
| PageSize | long | 否 | 分頁查詢時設置的每頁行數，最大值 100，默認為 20。 | 20 |
| SearchMode | string | 否 | 搜索模式。取值：
| LIKE |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-resourcegroupid01 |
| Starmark | boolean | 否 | 是否查詢域名星標。 | true |
返回參數
示例
正常返回示例
JSON格式
{
"Domains": {
"Domain": [
{
"Remark": "remark",
"CreateTime": "2019-01-30T05:25Z",
"RecordCount": 100,
"Tags": {
"Tag": [
{
"Key": "測試標簽",
"Value": "測試標簽值"
}
]
},
"InstanceId": "i-7bg",
"DomainName": "abc.com",
"DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
"AliDomain": true,
"GroupId": "2223",
"GroupName": "mygroup",
"ResourceGroupId": "rg-acf",
"InstanceEndTime": "2020-03-14T16:00Z",
"InstanceExpired": false,
"VersionName": "企業標準版",
"DnsServers": {
"DnsServer": [
"{\"DnsServer\": [\"ns1.alidns.com\",\"ns2.alidns.com\"]}"
]
},
"VersionCode": "version_enterprise_basic",
"PunyCode": "abc.com",
"RegistrantEmail": "test@example.com",
"CreateTimestamp": 1660546144000,
"Starmark": true,
"DomainLoggingSwitchStatus": "OPEN"
}
]
},
"TotalCount": 2,
"PageSize": 2,
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"PageNumber": 1
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-17 | OpenAPI 返回結構發生變更 | 查看變更詳情 |