edit-icon download-icon

Retrieving Domain Name Lists

最終更新日: Dec 13, 2018

説明

入力パラメータに基づいて、このユーザーのドメイン名リストを照会します。

  • ページ番号(PageNumber)と各ページ(PageSize)のサイズは、ドメイン名のリストを取得するためにクエリで指定することができます。
  • ドメイン名のキーワード(KeyWord)をクエリで指定して、キーワードを含むドメイン名のリストを取得することができます。
  • デフォルトでは、ドメイン名のリストは、ドメイン名の追加順にソートされます。
  • ドメイン名グループ(GroupId)のIDをクエリで指定することができます。デフォルト値はAll Groupsです。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい 操作インタフェース名、必須パラメータ。値:DescribeDomains
PageNumber Long いいえ 現在のページの番号。デフォルトでは1から始まります。
PageSize Long いいえ これは、ページ単位での1行あたりの行数を設定します。デフォルトでは最大100行と20行です。
KeyWord String いいえ 大文字と小文字を区別しない “%KeyWord%”モードを使用する検索キーワード
GroupId String いいえ ドメイン名グループのID。記入されていない場合は、デフォルトですべてのグループです。

リターンパラメータ

パブリックリターンパラメータ。詳細は公開リターンパラメータを参照してください。

名前 説明
RequestId String 一意の要求識別子
TotalCount Long ドメイン名リストの総数
PageNumber Long 現在のページの番号
PageSize Long このクエリによって取得されたドメイン名の数
Domains DomainType この操作で取得されたドメインのリスト

エラーコード

すべてのインターフェイスに共通のエラーについては、エラーコードテーブルを参照してください。

エラーコード 説明 HTTPステータスコード 言語
InvalidDomainGroup.NotExist ドメイングループ名は存在しません。 400 ドメイン名グループは存在しません

リクエストの例

  1. http://dns.aliyuncs.com/?Action=DescribeDomains
  2. &PageNumber=1
  3. &PageSize=20
  4. &KeyWord=com
  5. &GroupId=2223
  6. &<Public Request Parameters>

リターンの例

XML形式

  1. <DescribeDomainsResponse>
  2. <RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
  3. <TotalCount>2</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>2</PageSize>
  6. <Domains>
  7. <Domain>
  8. <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
  9. <DomainName>abc.com</DomainName>
  10. <AliDomain>true</AliDomain>
  11. <GroupId>2223</GroupId>
  12. <PunyCode>abc.com</PunyCode>
  13. <InstanceId>i-7bg</InstanceId>
  14. <VersionCode>version1</VersionCode>
  15. <DnsServers>
  16. <DnsServer>dns1.hichina.com</DnsServer>
  17. <DnsServer>dns2.hichina.com</DnsServer>
  18. </DnsServers>
  19. </Domain>
  20. <Domain>
  21. <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
  22. <DomainName>Instance.com</DomainName>
  23. <AliDomain>false</AliDomain>
  24. <GroupId>2223</GroupId>
  25. <PunyCode>xn--fsq270a.com</PunyCode>
  26. <InstanceId>i-7bk</InstanceId>
  27. <VersionCode>version2</VersionCode>
  28. <DnsServers>
  29. <DnsServer>dns1.hichina.com</DnsServer>
  30. <DnsServer>dns2.hichina.com</DnsServer>
  31. </DnsServers>
  32. </Domain>
  33. </Domains>
  34. </DescribeDomainsResponse>

JSON形式

  1. {
  2. "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
  3. "TotalCount": 2,
  4. "PageNumber": 1,
  5. "PageSize": 2,
  6. "Domains": {
  7. "Domain": [
  8. {
  9. "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  10. "DomainName": "abc.com",
  11. "AliDomain": "true",
  12. "GroupId": "2223",
  13. "PunyCode": "abc.com",
  14. "InstanceId": "i-7bg",
  15. "VersionCode": "version1",
  16. "DnsServers": {
  17. "DnsServer": [
  18. "ns1.alidns.com",
  19. "ns2.alidns.com"
  20. ]
  21. }
  22. },
  23. {
  24. "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
  25. "DomainName": "Instance.com",
  26. "AliDomain": "false",
  27. "GroupId": "2223",
  28. "PunyCode": "xn--fsq270a.com",
  29. "InstanceId": "i-7bk",
  30. "VersionCode": "version2",
  31. "DnsServers": {
  32. "DnsServer": [
  33. "ns1.alidns.com",
  34. "ns2.alidns.com"
  35. ]
  36. }
  37. }
  38. ]
  39. }
  40. }