DescribeDomains untuk kueri daftar nama domain - Alibaba Cloud DNS - Alibaba Cloud - Alibaba Cloud DNS

Mengkueri daftar nama domain berdasarkan parameter yang ditentukan.

Deskripsi operasi

You can specify a page number (PageNumber) and page size (PageSize) to retrieve a paginated list of domain names.
You can specify a keyword (KeyWord) to query for domain names that contain the specified keyword.
By default, domain names are sorted in descending order of their creation time.
You can specify a domain name group ID (GroupId) to query for domain names in a specific group. This lets you retrieve all domain names or only the domain names that are not assigned to a group.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeDomains

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Lang	string	No	Bahasa tanggapan. Nilai valid: zh: Chinese en: English Nilai default: zh.	en
KeyWord	string	No	Kata kunci. Pencarian dilakukan dalam pola %KeyWord% dan tidak peka huruf besar-kecil.	com
GroupId	string	No	ID kelompok nama domain. Jika Anda mengosongkan parameter ini atau meneruskan string kosong, semua nama domain akan dikueri. Jika Anda mengatur parameter ini ke defaultGroup, nama domain dalam kelompok default akan dikueri.	defaultGroup
PageNumber	integer	No	Nomor halaman. Nilai dimulai dari 1. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum adalah 100. Nilai default adalah 20.	20
SearchMode	string	No	Mode pencarian. Nilai valid: LIKE: pencarian fuzzy EXACT: Pencarian tepat Nilai default: LIKE.	LIKE
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-re********
Starmark	boolean	No	Apakah akan mengkueri nama domain yang ditandai bintang. Nilai valid: true false Nilai default: true.	true

Elemen respons

Element	Type	Description	Example
	object
Domains	object
Domain	array<object>	The list of domain names.
	array<object>	The list of domain names.
Remark	string	The remarks.	remark
CreateTime	string	The time when the domain name was added.	2019-01-30T05:25Z
RecordCount	integer	The number of DNS records for the domain name.	100
Tags	object
Tag	array<object>	The array of tags.
	object
Key	string	The tag key.	测试标签
Value	string	The tag value.	测试标签值
InstanceId	string	The ID of the Alibaba Cloud DNS instance.	i-***
DomainName	string	The domain name.	example.com
DomainId	string	The ID of the domain name.	00efd71a-770e-4255-*********
AliDomain	boolean	Indicates whether the domain name was registered with Alibaba Cloud.	true
GroupId	string	The ID of the domain name group.	2***
GroupName	string	The name of the domain name group.	mygroup
ResourceGroupId	string	The ID of the resource group.	rg***
InstanceEndTime	string	The time when the instance expires.	2020-03-14T16:00Z
InstanceExpired	boolean	Indicates whether the instance has expired.	false
VersionName	string	The name of the Alibaba Cloud DNS edition.	企业旗舰版
DnsServers	object
DnsServer	array	The list of DNS servers assigned by Alibaba Cloud DNS.
	string	The DNS server assigned by Alibaba Cloud DNS.	{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}
VersionCode	string	The code of the Alibaba Cloud DNS edition.	version_enterprise_basic
PunyCode	string	The Punycode representation of the Chinese domain name. This parameter is empty for English domain names.	example.com
RegistrantEmail	string	The email address of the registrant.	****@example.com
CreateTimestamp	integer	The time when the domain name was added. This value is a UNIX timestamp.	1660546144000
Starmark	boolean	Indicates whether the domain name is starred.	true
DomainLoggingSwitchStatus	string	The status of DNS traffic analysis for the domain name: OPEN: enabled CLOSE: disabled	OPEN
SlaveDnsStatus	string
TotalCount	integer	The total number of domain names.	2
PageSize	integer	The number of entries per page. The maximum value is 100. The default value is 20.	2
RequestId	string	The unique ID of the request.	68386699-8B9E-4D5B-BC4C-75A28F6C2A00
PageNumber	integer	The page number. The value starts from 1. The default value is 1.	1

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.