ListCloudGtmAddressPools - - Centre de documentation Alibaba Cloud

Consulte la liste des pools d'adresses dans Global Traffic Manager (GTM) 3.0.

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

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 : Anglais. Il s'agit de la valeur par défaut.	en-US
ClientToken	string	Non	Un jeton généré par le client qui est utilisé pour garantir l'idempotence de la requête. Assurez-vous que le jeton est unique parmi les différentes requêtes. Le jeton peut contenir jusqu'à 64 caractères ASCII.	1ae05db4-10e7-11ef-b126-00163e24****
PageNumber	integer	Oui	Le numéro de page. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Oui	Le nombre d'entrées à renvoyer sur chaque page. La valeur maximale est 100. La valeur par défaut est 20.	20
AddressPoolName	string	Non	Le nom du pool d'adresses.	AddressPool-1
AddressPoolType	string	Non	Le type du pool d'adresses. Valeurs valides : IPv4 : le pool d'adresses contient des adresses IPv4. IPv6 : le pool d'adresses contient des adresses IPv6. domain : le pool d'adresses contient des noms de domaine.	IPv4
EnableStatus	string	Non	L'état du pool d'adresses. Valeurs valides : enable : le pool d'adresses est activé. disable : le pool d'adresses est désactivé.	enable
Remark	string	Non	Les remarques sur le pool d'adresses.	test

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	Le numéro de page. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Le nombre d'entrées renvoyées sur chaque page. La valeur maximale est 100. La valeur par défaut est 20.	20
TotalPages	integer	Le nombre total de pages.	1
TotalItems	integer	Le nombre total de pools d'adresses.	11
AddressPools	object	Les pools d'adresses.
AddressPool	array<object>	La liste des pools d'adresses.
	array<object>	Les informations sur le pool d'adresses.
CreateTime	string	The time when the address pool was created.	2024-03-15T01:46Z
CreateTimestamp	integer	The 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 timestamp that indicates when the address pool was last modified.	1527690629357
AddressPoolId	string	The ID of the address pool.	pool-89528023225442**16
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 the addresses in the address pool. Valid values: round_robin: Round-robin. For all requests, addresses are returned in sequence. sequence: Sequential. Addresses with smaller sequential numbers have higher priority and are returned first. If an address with a smaller sequential number is unavailable, the next address in the sequence is returned. weight: Weighted. You can set a weight for each address. Addresses are returned based on their weight ratio. source_nearest: Source-based nearest return. Global Traffic Manager (GTM) returns different addresses based on the source of the DNS requests to implement proximity-based access.	round_robin
SequenceLbStrategyMode	string	The service recovery mode for a primary address when the load balancing policy is sequence. Valid values: preemptive: Preemptive mode. The system preferentially uses the address with a smaller sequential number after the address recovers. non_preemptive: Non-preemptive mode. The system continues to use the current address after the previous address recovers.	preemptive
EnableStatus	string	The status of the address pool. Valid values: enable: The address pool is enabled. disable: The address pool is disabled.	enable
HealthJudgement	string	The condition for determining the health status of the address pool. Valid values: any_ok: At least one health check probe is normal. p30_ok: At least 30% of the health check probes are normal. p50_ok: At least 50% of the health check probes are normal. p70_ok: At least 70% of the health check probes are normal. all_ok: All health check probes are normal.	any_ok
HealthStatus	string	The health status of the address pool. Valid values: 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 resolution is performed for available addresses, but not for unavailable addresses. 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. Valid values: available: The address pool is available. unavailable: The address pool is 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 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 timestamp that indicates when the address was last modified.	1527690629357
AddressId	string	The ID of the address.	addr-89518218114368****
WeightValue	integer	The weight of the address. The value is an integer from 1 to 100. You can set a weight for each address. DNS requests are resolved based on the weight ratio.	1
SerialNumber	integer	The sequential number of the address. This number indicates the priority of the address. A smaller value indicates a higher priority.	1
RequestSource	object	The request source.
RequestSource	array	The list of request sources.
	string	The source of the request. GTM schedules traffic based on the egress IP address of the local DNS (LDNS) server that a user uses. If the LDNS server supports Extension Mechanisms for DNS (EDNS) client subnet (ECS), GTM can also schedule traffic based on the user's IP address.	["default"]
Name	string	The name of the address.	Address-1
Type	string	The type of the address. Valid values: 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 for the address.	test
EnableStatus	string	The status of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The health check-based failover method for the address. Valid values: auto: Automatic failover. If the health check result is abnormal, DNS resolution stops. If the health check result is normal, DNS resolution resumes. manual: Manual failover. If the address is in the abnormal state, DNS resolution stops. DNS resolution does not resume even if the health check result is normal. If the address is in the normal state, DNS resolution resumes. If the health check result is abnormal, an alert is generated, but DNS resolution does not stop.	auto
ManualAvailableStatus	string	The availability status of the address when the value of AvailableMode is manual. Valid values: available: Normal. In this state, DNS resolution is performed for the address. An alert is generated if the health check result is abnormal, but DNS resolution does not stop. unavailable: Abnormal. In this state, DNS resolution stops. DNS resolution does not resume even if the health check result is normal.	available
AvailableStatus	string	The availability status of the address. Valid values: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health status of the address. Valid values: ok: All health check probes for the address are normal. ok_alert: Some health check probes for the address are abnormal, but the address is still considered normal. ok_no_monitor: The address is not associated with any health check templates and is considered normal. exceptional: Some or all health check probes for the address are abnormal, and the address is considered abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: At least one health check probe is normal. p30_ok: At least 30% of the health check probes are normal. p50_ok: At least 50% of the health check probes are normal. p70_ok: At least 70% of the health check probes are normal. all_ok: All health check probes are normal.	any_ok
HealthTasks	object	The health check tasks.
HealthTask	array<object>	The list of health check tasks.
	object	The information about the health check task.
Port	integer	The service port of the address that is checked. This parameter is not supported when the health check protocol is ping.	80
TemplateId	string	The ID of the health check template.	mtp-89518052425100****
TemplateName	string	The name of the health check template.	IPv4-Ping
SeqNonPreemptiveSchedule	boolean	Indicates whether the address is a sequential non-preemptive scheduling object for hybrid cloud management scenarios. Valid values: true false	false
Remark	string	The remarks for the address pool.	test

Exemples

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 11,
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442**16",
        "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-89518218114368****",
              "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",
              "HealthTasks": {
                "HealthTask": [
                  {
                    "Port": 80,
                    "TemplateId": "mtp-89518052425100****",
                    "TemplateName": "IPv4-Ping"
                  }
                ]
              },
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "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.