DescribeDomains

説明

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

ページ番号(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	ドメイン名グループは存在しません

例

リクエストの例

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

リターンの例

XML形式

<DescribeDomainsResponse>
    <RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <Domains>
        <Domain>
            <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
            <DomainName>abc.com</DomainName>
            <AliDomain>true</AliDomain>
            <GroupId>2223</GroupId>
            <PunyCode>abc.com</PunyCode>
            <InstanceId>i-7bg</InstanceId>
            <VersionCode>version1</VersionCode>
            <DnsServers>
                <DnsServer>dns1.hichina.com</DnsServer>
                <DnsServer>dns2.hichina.com</DnsServer>
            </DnsServers>
        </Domain>
        <Domain>
            <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
            <DomainName>Instance.com</DomainName>
            <AliDomain>false</AliDomain>
            <GroupId>2223</GroupId>
            <PunyCode>xn--fsq270a.com</PunyCode>
            <InstanceId>i-7bk</InstanceId>
            <VersionCode>version2</VersionCode>
            <DnsServers>
                <DnsServer>dns1.hichina.com</DnsServer>
                <DnsServer>dns2.hichina.com</DnsServer>
            </DnsServers>
        </Domain>
    </Domains>
</DescribeDomainsResponse>

JSON形式

{
    "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 2,
    "Domains": {
        "Domain": [
            {
                "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
                "DomainName": "abc.com",
                "AliDomain": "true",
                "GroupId": "2223",
                "PunyCode": "abc.com",
                "InstanceId": "i-7bg",
                "VersionCode": "version1",
                "DnsServers": {
                    "DnsServer": [
                        "ns1.alidns.com",
                        "ns2.alidns.com"
                    ]
                }
            },
            {
                "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
                "DomainName": "Instance.com",
                "AliDomain": "false",
                "GroupId": "2223",
                "PunyCode": "xn--fsq270a.com",
                "InstanceId": "i-7bk",
                "VersionCode": "version2",
                "DnsServers": {
                    "DnsServer": [
                        "ns1.alidns.com",
                        "ns2.alidns.com"
                    ]
                }
            }
        ]
    }
}