DescribeGtmInstanceAddressPools - - Centre de documentation Alibaba Cloud

Décrit les pools d'adresses d'une instance Global Traffic Manager (GTM).

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

get

*GtmInstance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	La langue.	en
InstanceId	string	Oui	L'identifiant de l'instance GTM.	gtmtest
PageNumber	integer	Non	Le numéro de page. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Non	Le nombre d'entrées à retourner sur chaque page pour une requête paginée. La valeur maximale est 100. La valeur par défaut est 20.	20

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées retournées par page.	20
RequestId	string	L'identifiant unique de la requête.	6856BCF6-11D6-4D7E-AC53-FD579933522B
PageNumber	integer	Le numéro de la page retournée.	1
TotalPages	integer	Le nombre total de pages retournées.	1
TotalItems	integer	Le nombre total d'entrées retournées.	2
AddrPools	object
AddrPool	array<object>	Les pools d'adresses.
	object
Type	string	The type of the address pool. Valid values: IP: IP address DOMAIN: Domain name	IP
Status	string	The availability status of the address pool. Valid values: AVAILABLE: The address pool is available. NOT_AVAILABLE: The address pool is unavailable.	AVAILABLE
UpdateTime	string	The time when the address pool was last updated.	2017-12-28T13:08Z
CreateTime	string	The time when the address pool was created.	2017-12-28T13:08Z
MonitorConfigId	string	The ID of the health check configuration.	100abc
MinAvailableAddrNum	integer	The minimum number of available addresses in the address pool.	2
UpdateTimestamp	integer	The timestamp that indicates when the address pool was last updated.	1527690629357
MonitorStatus	string	The health check status. Valid values: OPEN: Health checks are enabled. CLOSE: Health checks are disabled. UNCONFIGURED: Health checks are not configured.	OPEN
AddrPoolId	string	The ID of the address pool.	hrbpnf
Name	string	The name of the address pool.	test
AddrCount	integer	The number of addresses in the address pool.	2
CreateTimestamp	integer	The timestamp that indicates when the address pool was created.	1527690629357

Exemples

JSON format

{
  "PageSize": 20,
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 2,
  "AddrPools": {
    "AddrPool": [
      {
        "Type": "IP",
        "Status": "AVAILABLE",
        "UpdateTime": "2017-12-28T13:08Z",
        "CreateTime": "2017-12-28T13:08Z",
        "MonitorConfigId": "100abc",
        "MinAvailableAddrNum": 2,
        "UpdateTimestamp": 1527690629357,
        "MonitorStatus": "OPEN",
        "AddrPoolId": "hrbpnf",
        "Name": "test",
        "AddrCount": 2,
        "CreateTimestamp": 1527690629357
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.