DescribeGtmInstances - - Centre de documentation Alibaba Cloud

Consulte les instances 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:DescribeGtmInstances

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	La langue.	en
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
Keyword	string	Non	Le mot-clé pour une recherche de correspondance exacte par identifiant d'instance ou nom d'instance.	test
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-xxxxx
NeedDetailAttributes	boolean	Non	Indique si des informations détaillées doivent être retournées. La valeur par défaut est false.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées retournées sur chaque page.	20
RequestId	string	L'identifiant unique de la requête.	193B0163-7F93-42DF-AB05-ACEEB7D22707
PageNumber	integer	Le numéro de la page retournée.	1
GtmInstances	object
GtmInstance	array<object>	La liste des instances GTM.
	object
ExpireTime	string	The time when the instance expires.	2018-06-06T11:34Z
AccessStrategyNum	integer	The number of access policies.	5
CreateTime	string	The time when the instance was created.	2018-06-06T11:34Z
CnameMode	string	The connection type. Valid values: SYSTEM_ASSIGN: System-assigned CUSTOM: Custom	CUSTOM
InstanceId	string	The ID of the instance.	gtm-cn-wwo3a3hbz**
ExpireTimestamp	integer	The UNIX timestamp that indicates when the instance expires.	1528284856000
Ttl	integer	The global TTL.	60
AlertGroup	string	The alert contact group.	[\"研发组\"]
AddressPoolNum	integer	The number of address pools.	5
InstanceName	string	The name of the instance.	test
LbaStrategy	string	The load balancing policy. ALL_RR: Round-robin RATIO: Weighted round-robin	RATIO
Cname	string	The CNAME for instance access.	gtm-cn-wwo3a3hbz**.dns-example.top
VersionCode	string	The version code.	biaozhun
UserDomainName	string	The custom domain name.	dns-example.top
CreateTimestamp	integer	The UNIX timestamp that indicates when the instance was created.	1528284856000
ResourceGroupId	string	The ID of the resource group.	rg-acfm2q2jqpjh***
TotalPages	integer	Le nombre total de pages.	1
TotalItems	integer	Le nombre total d'éléments.	1

Exemples

JSON format

{
  "PageSize": 20,
  "RequestId": "193B0163-7F93-42DF-AB05-ACEEB7D22707",
  "PageNumber": 1,
  "GtmInstances": {
    "GtmInstance": [
      {
        "ExpireTime": "2018-06-06T11:34Z",
        "AccessStrategyNum": 5,
        "CreateTime": "2018-06-06T11:34Z",
        "CnameMode": "CUSTOM",
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "ExpireTimestamp": 1528284856000,
        "Ttl": 60,
        "AlertGroup": "[\\\"研发组\\\"]",
        "AddressPoolNum": 5,
        "InstanceName": "test",
        "LbaStrategy": "RATIO",
        "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top\n",
        "VersionCode": "biaozhun",
        "UserDomainName": "dns-example.top",
        "CreateTimestamp": 1528284856000,
        "ResourceGroupId": "rg-acfm2q2jqpjh***"
      }
    ]
  },
  "TotalPages": 1,
  "TotalItems": 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.