SearchCloudGtmInstanceConfigs - - Centre de documentation Alibaba Cloud

Obtient les configurations d'instance qui correspondent aux paramètres spécifiés.

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

list

*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` (par défaut) : anglais	zh-CN
ClientToken	string	Non	Un jeton généré par le client pour garantir l'idempotence de la requête. Le jeton doit être unique pour toutes les requêtes et peut contenir jusqu'à 64 caractères ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
PageNumber	integer	Oui	Le numéro de page. Les pages commencent à 1. La valeur par défaut est 1.	1
PageSize	integer	Oui	Le nombre d'entrées par page pour une requête paginée. La valeur maximale est 100 et la valeur par défaut est 20.	20
InstanceId	string	Non	L'identifiant de l'instance Global Traffic Manager (GTM) 3.0.	gtm-cn-wwo3a3h****
ScheduleZoneName	string	Non	Le nom de domaine principal (par exemple, `example.com`) ou le nom de sous-domaine (par exemple, `a.example.com`) du domaine d'accès GTM. Il s'agit généralement d'un nom de domaine géré par Alibaba Cloud DNS sous le même compte que celui qui possède l'instance GTM.	example.com
ScheduleDomainName	string	Non	Le domaine d'accès GTM. Il est formé en combinant l'enregistrement d'hôte (`ScheduleHostname`) avec le nom de domaine principal ou de sous-domaine (`ScheduleZoneName`).	www.example.com
EnableStatus	string	Non	L'état de la configuration de l'instance. Valeurs valides : `enable` : Activé. La stratégie de planification intelligente de l'instance GTM est en vigueur. `disable` : Désactivé. La stratégie de planification intelligente de l'instance GTM est indisponible.	enable
Remark	string	Non	Une remarque pour la configuration de l'instance.	test
HealthStatus	string	Non	L'état de santé de la configuration de l'instance. Valeurs valides : `ok` : Normal. Tous les pools d'adresses référencés par le domaine d'accès GTM sont disponibles. `ok_alert` : Alerte. Certains pools d'adresses référencés par le domaine d'accès GTM sont indisponibles. Dans cet état, la résolution DNS se poursuit pour les pools d'adresses disponibles, mais s'arrête pour les pools indisponibles. `exceptional` : Exceptionnel. Tous les pools d'adresses référencés par le domaine d'accès GTM sont indisponibles. Dans ce cas, la résolution de basculement utilise les adresses du pool d'adresses non vide ayant le plus petit numéro de séquence afin de garantir que les clients reçoivent un résultat de résolution.	ok
AvailableStatus	string	Non	L'état de disponibilité du service de la configuration de l'instance. Valeurs valides : `available` : le service pour le domaine d'accès GTM est disponible lorsque la configuration de l'instance est activée et que son état de santé est Normal ou Alerte. `unavailable` : le service pour le domaine d'accès GTM est indisponible lorsque la configuration de l'instance est désactivée ou que son état de santé est Exceptionnel.	available

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant unique de la requête.	6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
PageNumber	integer	Le numéro de page. La valeur de départ est 1. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées à renvoyer sur chaque page. Valeur maximale : 100. Valeur par défaut : 20.	20
TotalPages	integer	Le nombre total de pages.	1
TotalItems	integer	Le nombre total de configurations d'instance.	15
InstanceConfigs	object
InstanceConfig	array<object>	La liste des configurations d'instance.
	array<object>	La configuration de l'instance.
InstanceId	string	The ID of the Global Traffic Manager (GTM) 3.0 instance.	gtm-cn-x0r38e0****
ConfigId	string	The unique ID of the instance configuration. An access domain name can have both A and AAAA records on the same GTM instance, each with a separate configuration. This ID distinguishes between these configurations.	Config-000****
CreateTime	string	The time when the instance configuration was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The timestamp when the instance configuration was created.	1527690629357
UpdateTime	string	The time when the instance configuration was last updated.	2024-03-15T01:46Z
UpdateTimestamp	integer	The timestamp when the instance configuration was last updated.	1527690629357
VersionCode	string	The edition of the GTM 3.0 instance. Valid values: `standard`: Standard Edition `ultimate`: Ultimate Edition	ultimate
CommodityCode	string	The commodity code. Valid values: `dns_gtm_public_cn`: The commodity code for the Alibaba Cloud China website. `dns_gtm_public_intl`: The commodity code for the Alibaba Cloud International website.	dns_gtm_public_cn
ScheduleZoneMode	string	The assignment mode for the access domain name. Valid values: `custom`: A custom access domain name. You generate it by customizing the host record and associating it with a domain managed by authoritative DNS in your GTM instance account. `sys_assign`: The system assigns a default access domain name. This mode is no longer supported. Do not use this mode.	custom
ScheduleZoneName	string	The root domain (for example, `example.com`) or subdomain (for example, `a.example.com`) of the GTM access domain name. This domain is typically managed by Alibaba Cloud DNS 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, formed by combining the host record (`ScheduleHostname`) and the root domain or subdomain (`ScheduleZoneName`).	www.example.com
ScheduleRrType	string	The record type of the access domain name. Valid values: `A`: IPv4 address `AAAA`: IPv6 address `CNAME`: CNAME record	A
Ttl	integer	The Time to Live (TTL) for the DNS record, in seconds. This value determines how long the record for the access domain name is cached by ISP DNS servers.	60
AddressPoolLbStrategy	string	The load balancing policy for address pools. Valid values: `round_robin`: Returns all address pools in a rotating order for each DNS request. `sequence`: Returns the available address pool with the smallest sequence number (highest priority). `weight`: GTM routes DNS requests to address pools based on their weight ratios. `source_nearest`: GTM returns an address pool based on the request's source to provide the nearest access for users.	round_robin
SequenceLbStrategyMode	string	When using the `sequence` load balancing policy, this parameter specifies how traffic is handled when a higher-priority address pool recovers. Valid values: `preemptive`: In preemptive mode, traffic is switched back to the higher-priority address pool. `non_preemptive`: In non-preemptive mode, traffic continues to be routed to the current address pool.	preemptive
AvailableStatus	string	The availability status of the instance configuration. Valid values: `available`: The instance configuration is enabled and its health status is normal. `unavailable`: The instance configuration is disabled or its health status is abnormal.	available
EnableStatus	string	The enabled status of the instance configuration. Valid values: `enable`: The scheduling policy is active. `disable`: The scheduling policy is inactive.	enable
HealthStatus	string	The health status of the instance configuration. Valid values: `ok`: All address pools referenced by the access domain name are healthy. `ok_alert`: Some referenced address pools are unhealthy, but the overall instance is still operational. DNS resolution continues for healthy pools while it stops for unhealthy ones. `exceptional`: All referenced address pools are unhealthy. GTM performs failover resolution by using an address from the failover address pool with the lowest sequence number.	ok
Remark	string	The remark for the instance configuration.	test
AddressPools	object
AddressPool	array<object>	The list of address pools.
	array<object>	The address pool.
CreateTime	string	The time when the address pool was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The timestamp when the address pool was created.	1527690629357
UpdateTime	string	The time when the address pool was last updated.	2024-03-15T01:46Z
UpdateTimestamp	integer	The timestamp when the address pool was last updated.	1527690629357
AddressPoolId	string	The unique ID of the address pool.	pool-89564504435014**60
WeightValue	integer	The weight of the address pool. You can set a weight for each address pool to route DNS requests based on weight ratios. Valid values: integers from 1 to 100, inclusive.	1
SerialNumber	integer	The priority of the address pool, used for sequence-based load balancing. A smaller value indicates a higher priority, and the address pool with the highest priority is returned first.	1
RequestSource	object
RequestSource	array	The list of DNS request sources.
	string	The source of the DNS request. GTM routes traffic based on the egress IP address of the local DNS server that the client uses. If the local DNS server supports EDNS Client Subnet (ECS), GTM can perform more precise routing based on the client's IP address.	["default"]
AddressPoolName	string	The name of the address pool.	AddressPool-1
AddressPoolType	string	The type of the address pool. Valid values: `IPv4` `IPv6` `domain`	IPv4
AddressLbStrategy	string	The load balancing policy for addresses in the address pool. Valid values: `round_robin`: Returns all addresses in a rotating order for each DNS request. `sequence`: Returns the available address with the smallest sequence number (highest priority). `weight`: You can set a weight for each address. DNS requests are then routed to addresses based on their weight ratios. `source_nearest`: GTM returns an address based on the request's source to provide the nearest access for users.	round_robin
SequenceLbStrategyMode	string	If the load balancing policy for addresses is `sequence`, this parameter specifies the service recovery mode after a higher-priority address becomes available again. Valid values: `preemptive`: In preemptive mode, traffic is switched back to the higher-priority address. `non_preemptive`: In non-preemptive mode, traffic continues to be routed to the current address.	preemptive
EnableStatus	string	The enabled status of the address pool. Valid values: `enable`: Enabled `disable`: Disabled	enable
HealthJudgement	string	The condition for determining the health status of the address pool. Valid values: `any_ok`: The address pool is considered healthy if at least one address is available. `p30_ok`: The address pool is considered healthy if at least 30% of its addresses are available. `p50_ok`: The address pool is considered healthy if at least 50% of its addresses are available. `p70_ok`: The address pool is considered healthy if at least 70% of its addresses are available. `all_ok`: The address pool is considered healthy only if all of its addresses are available.	any_ok
HealthStatus	string	The health status of the address pool. Valid values: `ok`: All addresses in the address pool are available. `ok_alert`: Some addresses are unavailable, but the address pool is still considered healthy. In the warning state, DNS resolution continues for available addresses, but stops for unavailable addresses. `exceptional`: The address pool is considered unhealthy because some or all of its addresses are unavailable.	ok
AvailableStatus	string	The availability status of the address pool. Valid values: `available`: Available `unavailable`: Unavailable	available
SeqNonPreemptiveSchedule	boolean	Indicates whether non-preemptive sequential scheduling is used for this address pool. This mode is typically used in a multi-cloud management scenario. Valid values: `true`: Yes `false`: No	false
ConfigLoggingSwitchStatus	string		ENABLE

Exemples

JSON format

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-x0r38e0****",
        "ConfigId": "Config-000****\n",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "ScheduleZoneMode": "custom",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com",
        "ScheduleRrType": "A",
        "Ttl": 60,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test",
        "AddressPools": {
          "AddressPool": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressPoolId": "pool-89564504435014**60",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "AddressPoolName": "AddressPool-1",
              "AddressPoolType": "IPv4",
              "AddressLbStrategy": "round_robin",
              "SequenceLbStrategyMode": "preemptive",
              "EnableStatus": "enable",
              "HealthJudgement": "any_ok",
              "HealthStatus": "ok",
              "AvailableStatus": " available",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "ConfigLoggingSwitchStatus": "ENABLE"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.