DescribeCloudGtmAddressPoolReference - - Centre de documentation Alibaba Cloud

Obtient les informations sur les instances qui référencent un pool d'adresses.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh-CN : chinois. en-US : anglais. Il s'agit de la valeur par défaut.	en-US
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Générez un jeton pour vous assurer qu'il est unique parmi les différentes requêtes. Le jeton peut contenir jusqu'à 64 caractères ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
AddressPoolId	string	Non	L'identifiant unique du pool d'adresses.	pool-89528023225442****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant unique de la requête.	853805EA-3D47-47D5-9A1A-A45C24313ABD
AddressPoolId	string	L'identifiant unique du pool d'adresses.	pool-89528023225442****
AddressPoolName	string	Le nom du pool d'adresses.	app
InstanceConfigs	object
InstanceConfig	array<object>	Une liste des instances qui référencent le pool d'adresses.
	object	Une instance qui référence le pool d'adresses.
InstanceId	string	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-jmp3qnw****
ConfigId	string	The configuration ID of the domain name instance. You can configure both A and AAAA records for the same access domain name and GTM instance. In this case, two configurations are created for the GTM instance. The ConfigId parameter uniquely identifies a configuration.	config-00****
VersionCode	string	The edition of the GTM 3.0 instance. Valid values: standard: Standard Edition ultimate: Ultimate Edition	ultimate
InstanceName	string	The name of the instance.	test
ScheduleZoneName	string	The primary domain name, such as example.com, or the subdomain name, such as a.example.com, that is used to access GTM. This domain name is usually hosted in an authoritative zone in the Alibaba Cloud DNS console. The authoritative zone belongs to the same account as the GTM instance.	example.com
ScheduleHostname	string	The host record of the domain name that is used to access GTM.	www
ScheduleDomainName	string	The domain name that is used to access GTM. The domain name is a combination of the host record (ScheduleHostname) and the primary or subdomain name (ScheduleZoneName).	www.example.com
ScheduleRrType	string	The DNS record type of the scheduling domain name. Valid values: A: IPv4 address AAAA: IPv6 address CNAME: canonical name	A
Ttl	integer	The global time to live (TTL). This is the TTL of the DNS record that maps the access domain name to an address in the address pool. The global TTL affects how long the DNS record is cached on a carrier's recursive DNS server. You can specify a custom TTL.	30
AddressPoolLbStrategy	string	The load balancing policy for the address pools. Valid values: round_robin: Polling. All address pools are returned for any DNS request. The address pools are rotated for each request. sequence: Sequential. The address pool with the smallest ordinal number is returned for any DNS request. A smaller ordinal number indicates a higher priority. If the address pool with the highest priority is unavailable, the address pool with the second highest priority is returned. weight: Weighted. You can set different weights for each address pool. DNS requests are then routed to address pools based on their weights. source_nearest: Source proximity. This is the intelligent DNS resolution feature. GTM returns different address pools based on the source of DNS requests. This allows users to access the nearest location.	round_robin
SequenceLbStrategyMode	string	The service recovery mode when the load balancing policy is sequence and a high-priority resource recovers from an exception. Valid values: preemptive: Preemptive mode. If a high-priority address pool recovers, traffic is immediately switched to it. non_preemptive: Non-preemptive mode. If a high-priority address pool recovers, traffic remains with the current address pool.	preemptive
AvailableStatus	string	The availability status of the domain name instance service. Valid values: available: The domain name is enabled and healthy. The service for the access domain name is available. unavailable: The domain name is disabled or unhealthy. The service for the access domain name is unavailable.	available
EnableStatus	string	The enabled status of the domain name instance. Valid values: enable: Enabled. The intelligent scheduling policy of the GTM instance is active. disable: Disabled. The intelligent scheduling policy of the GTM instance is inactive.	enable
HealthStatus	string	The health status of the domain name instance. Valid values: ok: Normal. All address pools referenced by the access domain name are available. ok_alert: Warning. Some of the address pools referenced by the access domain name are unavailable. In this state, DNS resolution proceeds for available address pools, but stops for unavailable ones. exceptional: Abnormal. All address pools referenced by the access domain name are unavailable. In this case, failover resolution is performed using addresses from the non-empty address pool with the smallest ordinal number. This helps clients receive a DNS response.	ok
Remark	string	The remarks.	test

Exemples

JSON format

{
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "AddressPoolId": "pool-89528023225442****",
  "AddressPoolName": "app",
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-jmp3qnw****",
        "ConfigId": "config-00****",
        "VersionCode": "ultimate",
        "InstanceName": "test",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com",
        "ScheduleRrType": "A",
        "Ttl": 30,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.