DescribeDomains untuk kueri daftar nama domain - Alibaba Cloud DNS

Mengambil daftar nama domain berdasarkan parameter yang ditentukan.

Deskripsi operasi

Anda dapat menentukan nomor halaman (PageNumber) dan ukuran halaman (PageSize) untuk mengambil daftar nama domain yang dipaginasi.
Anda dapat menentukan kata kunci (KeyWord) untuk mengambil nama domain yang mengandung kata kunci tersebut.
Secara default, nama domain diurutkan secara menurun berdasarkan waktu pembuatannya.
Anda dapat menentukan ID kelompok nama domain (GroupId) untuk mengambil nama domain dalam kelompok tertentu. Hal ini memungkinkan Anda mengambil semua nama domain atau hanya nama domain yang tidak ditetapkan ke kelompok mana pun.

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 respons. Nilai yang valid: zh: Chinese en: English Nilai default: zh.	en
KeyWord	string	No	Kata kunci. Pencarian dilakukan dengan pola %KeyWord% dan tidak peka huruf besar/kecil.	com
GroupId	string	No	ID kelompok nama domain. Jika Anda membiarkan parameter ini kosong atau meneruskan string kosong, semua nama domain akan ditanyakan. Jika Anda menyetel parameter ini ke defaultGroup, nama domain dalam kelompok default akan ditanyakan.	defaultGroup
PageNumber	integer	No	Nomor halaman. Nilainya 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 yang valid: LIKE: fuzzy search EXACT: exact search Nilai default: LIKE	LIKE
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-re********
Starmark	boolean	No	Menentukan apakah akan menanyakan nama domain yang diberi bintang. Nilai yang valid: true false Nilai default: true	true

Elemen respons

Element	Type	Description	Example
	object
Domains	object
Domain	array<object>	Daftar nama domain.
	array<object>	Daftar nama domain.
Remark	string	Catatan.	remark
CreateTime	string	Waktu saat nama domain ditambahkan.	2019-01-30T05:25Z
RecordCount	integer	Jumlah rekaman DNS untuk nama domain tersebut.	100
Tags	object
Tag	array<object>	Array tag.
	object
Key	string	Kunci tag.	测试标签
Value	string	Nilai tag.	测试标签值
InstanceId	string	ID instans Alibaba Cloud DNS.	i-***
DomainName	string	Nama domain.	example.com
DomainId	string	ID nama domain.	00efd71a-770e-4255-*********
AliDomain	boolean	Menunjukkan apakah nama domain didaftarkan melalui Alibaba Cloud.	true
GroupId	string	ID kelompok nama domain.	2***
GroupName	string	Nama kelompok nama domain.	mygroup
ResourceGroupId	string	ID kelompok sumber daya.	rg***
InstanceEndTime	string	Waktu kedaluwarsa instans.	2020-03-14T16:00Z
InstanceExpired	boolean	Menunjukkan apakah instans telah kedaluwarsa.	false
VersionName	string	Nama edisi Alibaba Cloud DNS.	企业旗舰版
DnsServers	object
DnsServer	array	Daftar server DNS yang ditetapkan oleh Alibaba Cloud DNS.
	string	Server DNS yang ditetapkan oleh Alibaba Cloud DNS.	{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}
VersionCode	string	Kode edisi Alibaba Cloud DNS.	version_enterprise_basic
PunyCode	string	Representasi Punycode dari nama domain dalam bahasa Mandarin. Parameter ini kosong untuk nama domain dalam bahasa Inggris.	example.com
RegistrantEmail	string	Alamat email pemegang domain.	****@example.com
CreateTimestamp	integer	Waktu saat nama domain ditambahkan. Nilai ini merupakan stempel waktu UNIX.	1660546144000
Starmark	boolean	Menunjukkan apakah nama domain diberi bintang.	true
DomainLoggingSwitchStatus	string	Status analisis traffic DNS untuk nama domain: OPEN: diaktifkan CLOSE: dinonaktifkan	OPEN
SlaveDnsStatus	string
TotalCount	integer	Total jumlah nama domain.	2
PageSize	integer	Jumlah entri per halaman. Nilai maksimum adalah 100. Nilai default adalah 20.	2
RequestId	string	ID unik permintaan.	68386699-8B9E-4D5B-BC4C-75A28F6C2A00
PageNumber	integer	Nomor halaman. Nilainya dimulai dari 1. Nilai default adalah 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.