DescribeDomains - - Centre de documentation Alibaba Cloud

Consulte la liste des noms de domaine en fonction des paramètres spécifiés.

Description de l'opération

Vous pouvez spécifier un numéro de page (PageNumber) et une taille de page (PageSize) pour récupérer une liste paginée de noms de domaine.\n\n2. Vous pouvez spécifier un mot-clé (KeyWord) pour rechercher les noms de domaine contenant le mot-clé spécifié.\n\n3. Par défaut, les noms de domaine sont triés par ordre décroissant de leur heure de création.\n\n4. Vous pouvez spécifier l'identifiant d'un groupe de noms de domaine (GroupId) pour rechercher les noms de domaine d'un groupe spécifique. Cela vous permet de récupérer tous les noms de domaine ou uniquement ceux qui ne sont pas assignés à un groupe.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

alidns:DescribeDomains

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	La langue de la réponse. Valeurs valides :\n\n- zh : chinois\n\n- en : anglais\n\nValeur par défaut : zh.	en
KeyWord	string	Non	Le mot-clé. La recherche est effectuée selon le modèle %KeyWord% et n'est pas sensible à la casse.	com
GroupId	string	Non	L'identifiant du groupe de noms de domaine.\n\nSi vous laissez ce paramètre vide ou si vous transmettez une chaîne vide, tous les noms de domaine sont interrogés.\n\nSi vous définissez ce paramètre sur defaultGroup, les noms de domaine du groupe par défaut sont interrogés.	defaultGroup
PageNumber	integer	Non	Le numéro de page. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. La valeur maximale est 100. La valeur par défaut est 20.	20
SearchMode	string	Non	Le mode de recherche. Valeurs valides : LIKE : recherche floue EXACT : recherche exacte Valeur par défaut : LIKE	LIKE
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-re********
Starmark	boolean	Non	Indique si les noms de domaine favoris doivent être interrogés. Valeurs valides :\n\n- true\n\n- false\n\nValeur par défaut : true.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
Domains	object
Domain	array<object>	La liste des noms de domaine.
	array<object>	La liste des noms de domaine.
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	Le nombre total de noms de domaine.	2
PageSize	integer	Le nombre d'entrées par page. La valeur maximale est 100. La valeur par défaut est 20.	2
RequestId	string	L'identifiant unique de la requête.	68386699-8B9E-4D5B-BC4C-75A28F6C2A00
PageNumber	integer	Le numéro de page. La valeur commence à 1. La valeur par défaut est 1.	1

Exemples

JSON format

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.