指定されたパラメータに基づいて、ドメイン名リストをクエリします。
操作説明
ページ番号 (PageNumber) とページサイズ (PageSize) を指定して、ドメイン名のページ分割リストを取得できます。
キーワード (KeyWord) を指定して、指定されたキーワードを含むドメイン名をクエリできます。
デフォルトでは、ドメイン名は作成時間の降順でソートされます。
ドメイン名グループ ID (GroupId) を指定して、特定のグループ内のドメイン名をクエリできます。 これにより、すべてのドメイン名、またはグループに割り当てられていないドメイン名のみを取得できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
alidns:DescribeDomains |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Lang |
string |
任意 |
レスポンスの言語。有効な値：
デフォルト値: zh。 |
en |
| KeyWord |
string |
任意 |
キーワード。 検索は %KeyWord% パターンで実行され、大文字と小文字は区別されません。 |
com |
| GroupId |
string |
任意 |
ドメイン名グループの ID。 このパラメータを空のままにするか、空の文字列を渡すと、すべてのドメイン名がクエリされます。 このパラメータを defaultGroup に設定すると、デフォルトグループのドメイン名がクエリされます。 |
defaultGroup |
| PageNumber |
integer |
任意 |
ページ番号。 値は 1 から始まります。 デフォルト値は 1 です。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。 最大値は 100 です。 デフォルト値は 20 です。 |
20 |
| SearchMode |
string |
任意 |
検索モード。有効な値：
デフォルト値: LIKE |
LIKE |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-re******** |
| Starmark |
boolean |
任意 |
スター付きドメイン名をクエリするかどうかを指定します。有効な値：
デフォルト値: true |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Domains |
object |
||
| Domain |
array<object> |
ドメイン名リスト。 |
|
|
object |
ドメイン名リスト。 |
||
| Remark |
string |
備考。 |
remark |
| CreateTime |
string |
ドメイン名が追加された日時。 |
2019-01-30T05:25Z |
| RecordCount |
integer |
ドメイン名の DNS レコードの数。 |
100 |
| Tags |
object |
||
| Tag |
array<object> |
タグの配列。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
测试标签 |
| Value |
string |
タグ値。 |
测试标签值 |
| InstanceId |
string |
Alibaba Cloud DNS インスタンスの ID。 |
i-*** |
| DomainName |
string |
ドメイン名。 |
example.com |
| DomainId |
string |
ドメイン名の ID。 |
00efd71a-770e-4255-********* |
| AliDomain |
boolean |
ドメイン名が Alibaba Cloud に登録されているかどうかを示します。 |
true |
| GroupId |
string |
ドメイン名グループの ID。 |
2*** |
| GroupName |
string |
ドメイン名グループの名前。 |
mygroup |
| ResourceGroupId |
string |
リソースグループの ID。 |
rg*** |
| InstanceEndTime |
string |
インスタンスの有効期限が切れる日時。 |
2020-03-14T16:00Z |
| InstanceExpired |
boolean |
インスタンスの有効期限が切れているかどうかを示します。 |
false |
| VersionName |
string |
Alibaba Cloud DNS エディションの名前。 |
企业旗舰版 |
| DnsServers |
object |
||
| DnsServer |
array |
Alibaba Cloud DNS によって割り当てられた DNS サーバのリスト。 |
|
|
string |
Alibaba Cloud DNS によって割り当てられた DNS サーバ。 |
{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]} |
|
| VersionCode |
string |
Alibaba Cloud DNS エディションのコード。 |
version_enterprise_basic |
| PunyCode |
string |
中国語ドメイン名のピュニコード表現。 このパラメータは、英語ドメイン名の場合は空です。 |
example.com |
| RegistrantEmail |
string |
登録者のメールアドレス。 |
****@example.com |
| CreateTimestamp |
integer |
ドメイン名が追加された日時。 この値は UNIX タイムスタンプです。 |
1660546144000 |
| Starmark |
boolean |
ドメイン名がスター付きかどうかを示します。 |
true |
| DomainLoggingSwitchStatus |
string |
ドメイン名の DNS トラフィック分析のステータス:
|
OPEN |
| SlaveDnsStatus |
string |
||
| TotalCount |
integer |
ドメイン名の総数。 |
2 |
| PageSize |
integer |
1 ページあたりのエントリ数。 最大値は 100 です。 デフォルト値は 20 です。 |
2 |
| RequestId |
string |
リクエストの固有 ID。 |
68386699-8B9E-4D5B-BC4C-75A28F6C2A00 |
| PageNumber |
integer |
ページ番号。 値は 1 から始まります。 デフォルト値は 1 です。 |
1 |
例
成功レスポンス
JSONJSON
{
"Domains": {
"Domain": [
{
"Remark": "remark",
"CreateTime": "2019-01-30T05:25Z",
"RecordCount": 100,
"Tags": {
"Tag": [
{
"Key": "测试标签",
"Value": "测试标签值"
}
]
},
"InstanceId": "i-***",
"DomainName": "example.com\n",
"DomainId": "00efd71a-770e-4255-*********",
"AliDomain": true,
"GroupId": "2***",
"GroupName": "mygroup",
"ResourceGroupId": "rg***",
"InstanceEndTime": "2020-03-14T16:00Z",
"InstanceExpired": false,
"VersionName": "企业旗舰版",
"DnsServers": {
"DnsServer": [
"{\"DnsServer\": [\"ns1.alidns.com\",\"ns2.alidns.com\"]}"
]
},
"VersionCode": "version_enterprise_basic",
"PunyCode": "example.com\n",
"RegistrantEmail": "****@example.com",
"CreateTimestamp": 1660546144000,
"Starmark": true,
"DomainLoggingSwitchStatus": "OPEN",
"SlaveDnsStatus": ""
}
]
},
"TotalCount": 2,
"PageSize": 2,
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"PageNumber": 1
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。