Tous les produits
Search
Centre de documentation

:DescribeCloudGtmInstanceConfigFullInfo

Dernière mise à jour :Aug 06, 2026

Consulte la configuration complète d'un nom de domaine d'accès GTM 3.0, y compris les paramètres d'alerte, les pools d'adresses et les détails des 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:DescribeCloudGtmInstanceConfigFullInfo

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

Aucune Aucune

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

AcceptLanguage

string

Non

La langue de la réponse. Valeurs valides :

en-US

ClientToken

string

Non

Le jeton client utilisé pour garantir l'idempotence de la requête. Générez un jeton unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères ASCII.

1ae05db4-10e7-11ef-b126-00163e24****

InstanceId

string

Non

L'identifiant de l'instance Global Traffic Manager 3.0.

gtm-cn-wwo3a3h****

ConfigId

string

Non

L'identifiant de la configuration de l'instance. Vous pouvez configurer à la fois des enregistrements A et AAAA pour le même nom de domaine d'accès et la même instance Global Traffic Manager (GTM). Dans ce cas, l'instance GTM possède deux configurations. Le ConfigId identifie de manière unique une configuration d'instance.

Config-000****

Éléments de réponse

Élément

Type

Description

Exemple

object

RequestId

string

L'identifiant de la requête.

29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

InstanceId

string

L'identifiant de l'instance Global Traffic Manager 3.0.

gtm-cn-wwo3a3h****

ConfigId

string

L'identifiant de la configuration de l'instance. Vous pouvez configurer à la fois des enregistrements A et AAAA pour le même nom de domaine d'accès et la même instance Global Traffic Manager (GTM). Dans ce cas, l'instance GTM possède deux configurations. Le ConfigId identifie de manière unique une configuration d'instance.

Config-000****

CreateTime

string

L'heure de création de l'instance.

2024-03-15T01:46Z

CreateTimestamp

integer

L'horodatage UNIX qui indique l'heure de création de l'instance.

1527690629357

UpdateTime

string

L'heure de la dernière modification de l'instance.

2024-03-15T01:46Z

UpdateTimestamp

integer

L'horodatage UNIX qui indique l'heure de la dernière modification de l'instance.

1527690629357

VersionCode

string

L'édition de l'instance Global Traffic Manager 3.0.

ultimate

CommodityCode

string

Le code produit.

dns_gtm_public_cn

InstanceName

string

Le nom de l'instance GTM.

test

ScheduleZoneMode

string

Le mode d'attribution du nom de domaine d'accès.

custom

ScheduleZoneName

string

Le nom de domaine principal (example.com) ou le nom de sous-domaine (a.example.com) du nom de domaine d'accès GTM. Il s'agit généralement d'un nom de domaine hébergé dans la zone faisant autorité de la console Alibaba Cloud DNS sous le compte auquel l'instance GTM appartient.

example.com

ScheduleHostname

string

L'enregistrement d'hôte du nom de domaine d'accès GTM.

www

ScheduleDomainName

string

Le nom de domaine d'accès GTM. Le format est ScheduleHostname + ScheduleZoneName.

www.example.com

ScheduleRrType

string

Le type d'enregistrement DNS du nom de domaine d'accès GTM.

A

Ttl

integer

Le temps de vie (TTL) global en secondes. Il s'agit de la valeur TTL pour les enregistrements DNS qui font correspondre le nom de domaine d'accès aux adresses du pool d'adresses. Cela affecte la durée de mise en cache des enregistrements DNS sur les serveurs DNS locaux des opérateurs. Vous pouvez personnaliser la valeur TTL.

60

AddressPoolLbStrategy

string

La stratégie de répartition de charge pour les pools d'adresses.

round_robin

SequenceLbStrategyMode

string

Lorsque la stratégie de répartition de charge pour les pools d'adresses est sequence, ce paramètre spécifie le mode de reprise de service pour une ressource qui redevient disponible.

preemptive

AvailableStatus

string

L'état de disponibilité du service de l'instance.

available

EnableStatus

string

L'état d'activation de l'instance.

enable

HealthStatus

string

L'état de santé de l'instance.

ok

AlertGroup

string

Le groupe d'alertes.

["云账号报警联系人"]

AlertConfig

string

La configuration des notifications d'alerte.

[{"NoticeType":"addr_alert","SmsNotice":true,"EmailNotice":true,"DingtalkNotice":true},{"NoticeType":"addr_resume","SmsNotice":true,"EmailNotice":true,"DingtalkNotice":true},{"NoticeType":"addr_pool_unavailable","SmsNotice":true,"EmailNotice":true,"DingtalkNotice":true},{"NoticeType":"addr_pool_available","SmsNotice":true,"EmailNotice":true,"DingtalkNotice":true}]"

Remark

string

Les remarques sur la configuration de l'instance.

test

AddressPools

object

Les pools d'adresses.

AddressPool

array<object>

La liste des pools d'adresses.

array<object>

La configuration du pool d'adresses.

CreateTime

string

The time when the address pool was created.

2024-03-15T01:46Z

CreateTimestamp

integer

The UNIX timestamp that indicates when the address pool was created.

1527690629357

UpdateTime

string

The time when the address pool was last modified.

2024-03-15T01:46Z

UpdateTimestamp

integer

The UNIX timestamp that indicates when the address pool was last modified.

1527690629357

AddressPoolId

string

The ID of the address pool. This is the unique identifier of the address pool.

pool-89528023225442****

WeightValue

integer

The weight of the address pool. The value is an integer from 1 to 100. You can set different weights for each address pool to return address pools based on the specified weight ratio.

1

SerialNumber

integer

The ordinal number of the address pool. For any DNS request, the address pool with the smallest ordinal number is returned. The ordinal number indicates the priority of the address pool. A smaller value indicates a higher priority.

1

RequestSource

object

The request source.

RequestSource

array

The list of DNS request sources.

string

The source of the DNS request. GTM schedules traffic based on the egress IP address of the local DNS server that the client uses. If the local DNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also schedule traffic based on the client IP address.

["default"]

AddressPoolName

string

The name of the address pool.

AddressPool-1

AddressPoolType

string

The type of the address pool.

  • IPv4

  • IPv6

  • domain

IPv4

AddressLbStrategy

string

The load balancing policy for the addresses in the address pool.

  • round_robin: Returns all addresses for any DNS request. The addresses are rotated in order for each request.

  • sequence: Returns the address with the smallest ordinal number for any DNS request. The ordinal number indicates the priority of the address. A smaller value indicates a higher priority. If the address with the smallest ordinal number is unavailable, the address with the next smallest ordinal number is returned.

  • weight: Returns addresses based on the specified weight for each address.

  • source_nearest: Returns different addresses based on the source of the DNS requests. This implements proximity-based access for users.

round_robin

SequenceLbStrategyMode

string

When the load balancing policy for addresses is sequence, this parameter specifies the service recovery mode for a resource that becomes available again.

  • preemptive: The address with the smaller ordinal number is preferentially used.

  • non_preemptive: The current address is still used.

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 address pool is available.

  • p30_ok: At least 30% of the addresses in the address pool are available.

  • p50_ok: At least 50% of the addresses in the address pool are available.

  • p70_ok: At least 70% of the addresses in the address pool are available.

  • all_ok: All addresses in the address pool are available.

any_ok

HealthStatus

string

The health status of the address pool.

  • ok: Normal. All addresses in the address pool are available.

  • ok_alert: Warning. Some addresses in the address pool are unavailable, but the address pool is still considered normal. In this state, DNS requests are resolved to the available addresses, but not to the unavailable ones.

  • exceptional: Abnormal. Some or all addresses in the address pool are unavailable, and the address pool is considered abnormal.

ok

AvailableStatus

string

The availability status of the address pool.

  • available: Available.

  • unavailable: Unavailable.

available

Addresses

object

The addresses.

Address

array<object>

The list of addresses.

array<object>

The information about the address.

CreateTime

string

The time when the address was created.

2024-03-15T01:46Z

CreateTimestamp

integer

The UNIX timestamp that indicates when the address was created.

1527690629357

UpdateTime

string

The time when the address was last modified.

2024-03-15T01:46Z

UpdateTimestamp

integer

The UNIX timestamp that indicates when the address was last modified.

1527690629357

AddressId

string

The ID of the address. This is the unique identifier of the address.

addr-89564712295703****

WeightValue

integer

The weight of the address. The value is an integer from 1 to 100. You can set different weights for each address to return addresses based on the specified weight ratio.

1

SerialNumber

integer

The ordinal number of the address. This indicates the priority of the address. A smaller value indicates a higher priority.

1

RequestSource

object

The request source.

RequestSource

array

The list of DNS request sources.

string

The source of the DNS request. GTM schedules 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 also schedule traffic based on the client IP address.

["default"]

Name

string

The name of the address.

Address-1

Type

string

The type of the address.

  • IPv4: IPv4 address

  • IPv6: IPv6 address

  • domain: domain name

IPv4

Address

string

The IP address or domain name.

223.5.XX.XX

AttributeInfo

string

The source of the address. This parameter is not returned in the current version.

当前版本不支持返回此参数。

Remark

string

The remarks on the address.

test

EnableStatus

string

The enabled status of the address. This indicates whether the address is currently available.

  • enable: Enabled.

  • disable: Disabled.

enable

AvailableMode

string

The failover mode for the address that becomes unavailable.

  • auto: Automatic mode. The system determines the availability based on health check results. If the health check result is abnormal, DNS resolution stops. If the health check result is normal, DNS resolution resumes.

  • manual: Manual mode. If the address is in the abnormal state, DNS resolution stops, and does not resume even if the health check result is normal. If the address is in the normal state, DNS resolution resumes. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop.

auto

ManualAvailableStatus

string

When the failover mode for the address is manual, this parameter specifies the availability status of the address.

  • available: Normal. In this state, DNS requests are resolved to the address. An alert is triggered if the health check result is abnormal, but DNS resolution does not stop.

  • unavailable: Abnormal. In this state, DNS resolution stops and does not resume even if the health check result is normal.

available

AvailableStatus

string

The availability status of the address.

  • available: The address is available.

  • unavailable: The address is unavailable.

available

HealthStatus

string

The health check status of the address.

  • ok: All health check tasks for the referenced health check templates are normal.

  • ok_alert: Some health check tasks for the referenced health check templates are abnormal, but the address is still considered normal.

  • ok_no_monitor: The address does not reference any health check templates and is considered normal.

  • exceptional: Some or all health check tasks for the referenced health check templates are abnormal, and the address is considered abnormal.

ok

HealthJudgement

string

The condition for determining the health status of the address.

  • any_ok: At least one health check is normal.

  • p30_ok: At least 30% of the health checks are normal.

  • p50_ok: At least 50% of the health checks are normal.

  • p70_ok: At least 70% of the health checks are normal.

  • all_ok: All health checks are normal.

any_ok

SeqNonPreemptiveSchedule

boolean

Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios.

  • true: Yes

  • false: No

false

SeqNonPreemptiveSchedule

boolean

Indicates whether the address is a scheduling object in sequential (non-preemptive) mode. This is for hybrid cloud management scenarios.

  • true: Yes

  • false: No

false

Exemples

JSON format

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3h****",
  "ConfigId": "Config-000****",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "VersionCode": "ultimate",
  "CommodityCode": "dns_gtm_public_cn",
  "InstanceName": "test",
  "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",
  "AlertGroup": "[\\\"云账号报警联系人\\\"]",
  "AlertConfig": "[{\\\"NoticeType\\\":\\\"addr_alert\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_resume\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_unavailable\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_available\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true}]\"",
  "Remark": "test",
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442****",
        "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",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89564712295703****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.