DescribeDnsGtmInstances - - Centre de documentation Alibaba Cloud

Consulte la liste des instances.

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:DescribeDnsGtmInstances

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	La langue de la réponse. Valeur par défaut : en. Valeurs valides : en, zh et ja.	en
PageNumber	integer	Non	Le numéro de la page à renvoyer. La valeur commence à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur maximale : 100. Valeur par défaut : 20.	1
Keyword	string	Non	Le mot-clé pour la requête. La recherche approximative par identifiant d'instance et par nom d'instance est prise en charge.	test
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-testgroupid

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées par page. Valeur maximale : 100. Valeur par défaut : 20.	1
RequestId	string	L'identifiant unique de la requête.	84314904-D047-4176-A0EC-256D7F68C7F5
PageNumber	integer	Le numéro de la page renvoyée. La valeur commence à 1. Valeur par défaut : 1.	1
GtmInstances	array<object>	La liste des instances Global Traffic Manager (GTM).
	array<object>
PaymentType	string	La méthode de facturation. Valeur valide : Subscription	Subscription
ExpireTime	string	L'heure d'expiration de l'instance.	2020-10-14T06:58Z
CreateTime	string	L'heure de création de l'instance.	2020-10-14T06:58Z
SmsQuota	integer	Le quota total de notifications par SMS.	1
InstanceId	string	L'identifiant de l'instance.	gtm-cn-wwo3a3hbz**
Config	object	La configuration de l'instance.
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group. The value is a JSON-formatted list of strings.	["test1","test2"]
PublicZoneName	string	The domain name used for Internet access.	gtm-cn-wwo3a3hbz**.dns-example.top
CnameType	string	The type of the CNAME domain name used for access. Valid value: PUBLIC: for Internet access	PUBLIC
StrategyMode	string	The mode of the access policy. Valid values: LATENCY: latency-based GEO: geography-based	GEO
InstanceName	string	The name of the instance.	instanceTest
PublicCnameMode	string	The method to access the instance over the Internet using a CNAME record. Valid values: CUSTOM: custom SYSTEM_ASSIGN: system-assigned (This feature is disabled.)	CUSTOM
AlertConfig	array<object>	The alert notification methods.
	object
SmsNotice	string	Indicates whether text message notifications are configured. Valid values: true: configured false or null: not configured	true
NoticeType	string	The type of the alert event. Valid values: ADDR_ALERT: The address is unavailable. ADDR_RESUME: The address is restored. ADDR_POOL_GROUP_UNAVAILABLE: The address pool collection is unavailable. ADDR_POOL_GROUP_AVAILABLE: The address pool collection is restored. ACCESS_STRATEGY_POOL_GROUP_SWITCH: A switchover occurs between the primary and secondary address pools.	ADDR_ALERT
EmailNotice	string	Indicates whether email notifications are configured. Valid values: true: configured false or null: not configured	true
DingtalkNotice	string	Indicates whether DingTalk notifications are configured. Valid values: true: configured false or null: not configured	true
PublicUserDomainName	string	The user's service domain name that is accessible over the Internet.	dns-example.top
PublicRr	string	The hostname for Internet access.	test.rr
ExpireTimestamp	integer	L'horodatage indiquant l'heure d'expiration de l'instance.	1602658709000
ResourceGroupId	string	L'identifiant du groupe de ressources.	resourceGroupid123
VersionCode	string	La version de l'instance.	standard
UsedQuota	object	Le quota utilisé.
EmailUsedCount	integer	The total number of emails that were sent.	100
TaskUsedCount	integer	The number of health check tasks that were created.	100
SmsUsedCount	integer	The total number of text messages that were sent.	100
DingtalkUsedCount	integer	The total number of DingTalk messages that were sent.	100
TaskQuota	integer	Le nombre total de tâches de vérification de l'état de santé.	1
CreateTimestamp	integer	L'horodatage indiquant l'heure de création de l'instance.	1602658709000
TotalPages	integer	Le nombre total de pages.	123
TotalItems	integer	Le nombre total d'entrées.	100

Exemples

JSON format

{
  "PageSize": 1,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "PageNumber": 1,
  "GtmInstances": [
    {
      "PaymentType": "Subscription",
      "ExpireTime": "2020-10-14T06:58Z",
      "CreateTime": "2020-10-14T06:58Z",
      "SmsQuota": 1,
      "InstanceId": "gtm-cn-wwo3a3hbz**",
      "Config": {
        "Ttl": 60,
        "AlertGroup": "[\"test1\",\"test2\"]",
        "PublicZoneName": "gtm-cn-wwo3a3hbz**.dns-example.top",
        "CnameType": "PUBLIC",
        "StrategyMode": "GEO",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "CUSTOM",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "dns-example.top",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "standard",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.