DescribeCloudGtmAddressReference - - Centre de documentation Alibaba Cloud

Consulte les pools d'adresses et les instances Global Traffic Manager (GTM) 3.0 qui référencent une adresse spécifiée.

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

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 (par défaut)	zh-CN
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Assurez-vous que le client génère un jeton unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	Non	L'identifiant unique de l'adresse.	addr-89518218114368****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant unique de la requête.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
AddressId	string	L'identifiant unique de l'adresse.	addr-89564584963974****
Name	string	Le nom de l'adresse.	Address-1
Address	string	L'adresse IP ou le nom de domaine.	223.5.XX.XX
AddressPools	object
AddressPool	array<object>	La liste des pools d'adresses.
	array<object>	Les informations relatives au pool d'adresses.
AddressPoolId	string	The ID of the address pool.	pool-89528023225442****
AddressPoolName	string	The name of the address pool.	AddressPool-1
InstanceConfigs	object
InstanceConfig	array<object>	The list of instances that reference the address pool.
	object	The configuration information of the instance that references the address pool.
InstanceId	string	The ID of the GTM 3.0 instance.	gtm-cn-zz11t58****
InstanceName	string	The name of the instance.	test
ConfigId	string	The ID of the instance configuration. If you configure both A and AAAA records for the same access domain name and GTM instance, two instance configurations are generated. `ConfigId` uniquely identifies an instance configuration.	config-00****
VersionCode	string	The version of the GTM 3.0 instance: standard: Standard Edition ultimate: Ultimate Edition	ultimate
ScheduleZoneName	string	The primary domain name (for example, example.com) or subdomain name (for example, a.example.com) for GTM access. This is usually a domain name hosted on the authoritative zone in the Alibaba Cloud DNS console under the same account as the GTM instance.	example.com
ScheduleHostname	string	The host record of the GTM access domain name.	www
ScheduleDomainName	string	The GTM access domain name. It 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: A: IPv4 address AAAA: AAAA record CNAME: Canonical name	A
Ttl	integer	The global Time to Live (TTL) in seconds. This is the TTL value for the DNS record that resolves the access domain name to an address in the address pool. It affects the cache duration of the DNS record on a carrier's Local DNS server. You can specify a custom TTL value.	30
AddressPoolLbStrategy	string	The load balancing policy for the address pools: round_robin: Polling. For any DNS query, all address pools are returned. The order of the address pools is rotated for each query. sequence: Sequential. For any DNS query, the address pool with the lowest ordinal number is returned. A lower ordinal number indicates a higher priority. If an address pool is unavailable, the one with the next lowest ordinal number is returned. weight: Weighted. You can set a different weight for each address pool. DNS queries are then routed to address pools based on their weight ratios. source_nearest: Source-based. This is the smart DNS resolution feature. GTM can return different address pools based on the source of the DNS query. This allows users to access the nearest resource.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for address pools is `sequence`, this parameter specifies the service recovery mode for when a primary resource becomes available again: preemptive: Preemptive mode. The service switches back to the address pool with the lower ordinal number once it becomes available. non_preemptive: Non-preemptive mode. The service continues to use the current address pool even after the primary address pool becomes available.	preemptive
AvailableStatus	string	The service availability status of the domain name instance: available: Available. The domain name is enabled and its health status is Normal. unavailable: Unavailable. The domain name is disabled or its health status is Abnormal.	available
EnableStatus	string	The enabled status of the domain name instance: enable: Enabled. The smart scheduling policy of the GTM instance is active. disable: Disabled. The smart scheduling policy of the GTM instance is inactive.	enable
HealthStatus	string	The health status of the domain name instance: 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, available address pools are used for DNS resolution, while unavailable ones are not. exceptional: Abnormal. All address pools referenced by the access domain name are unavailable. In this case, addresses from the non-empty address pool with the lowest ordinal number are used for failover resolution to provide a response to the client.	ok
Remark	string	The remarks.	test
AddressPoolType	string	The type of the address pool: IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	The load balancing policy for addresses within the address pool: round_robin: Polling. For any DNS query, all addresses are returned. The order of the addresses is rotated for each query. sequence: Sequential. For any DNS query, the address with the lowest ordinal number is returned. A lower ordinal number indicates a higher priority. If an address is unavailable, the one with the next lowest ordinal number is returned. weight: Weighted. You can set a different weight for each address. DNS queries are then routed to addresses based on their weight ratios. source_nearest: Source-based. This is the smart DNS resolution feature. GTM can return different addresses based on the source of the DNS query. This allows users to access the nearest resource.	round_robin
SequenceLbStrategyMode	string	When the load balancing policy for addresses is `sequence`, this parameter specifies the service recovery mode for when a primary resource becomes available again: preemptive: Preemptive mode. The service switches back to the address with the lower ordinal number once it becomes available. non_preemptive: Non-preemptive mode. The service continues to use the current address even after the primary address becomes available.	preemptive
EnableStatus	string	The enabled status of the address pool: enable: Enabled disable: Disabled	enable
HealthJudgement	string	The condition for determining the health status of the address pool: any_ok: At least one address in the pool is available. p30_ok: At least 30% of the addresses in the pool are available. p50_ok: At least 50% of the addresses in the pool are available. p70_ok: At least 70% of the addresses in the pool are available. all_ok: All addresses in the pool are available.	any_ok
HealthStatus	string	The health status of the address pool: ok: Normal. All addresses referenced by the address pool are available. ok_alert: Warning. Some addresses referenced by the address pool are unavailable, but the pool's status is still considered normal. In this state, available addresses are used for DNS resolution, while unavailable ones are not. exceptional: Abnormal. Some or all addresses referenced by the address pool are unavailable, and the pool's status is considered abnormal.	ok
AvailableStatus	string	The availability status of the address pool: available: Available unavailable: Unavailable	available
Remark	string	The remarks on the address pool.	pool-1

Exemples

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AddressId": "addr-89564584963974****",
  "Name": "Address-1",
  "Address": "223.5.XX.XX",
  "AddressPools": {
    "AddressPool": [
      {
        "AddressPoolId": "pool-89528023225442****",
        "AddressPoolName": "AddressPool-1",
        "InstanceConfigs": {
          "InstanceConfig": [
            {
              "InstanceId": "gtm-cn-zz11t58****",
              "InstanceName": "test",
              "ConfigId": "config-00****",
              "VersionCode": "ultimate",
              "ScheduleZoneName": "example.com\n",
              "ScheduleHostname": "www",
              "ScheduleDomainName": "www.example.com",
              "ScheduleRrType": "A",
              "Ttl": 30,
              "AddressPoolLbStrategy": "round_robin",
              "SequenceLbStrategyMode": " preemptive",
              "AvailableStatus": "available",
              "EnableStatus": "enable",
              "HealthStatus": "ok",
              "Remark": "test"
            }
          ]
        },
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Remark": "pool-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.