DescribeGtmInstance - - Centre de documentation Alibaba Cloud

Consulte les détails 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:DescribeGtmInstance

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.	instance1
NeedDetailAttributes	boolean	Non	Indique si des informations supplémentaires doivent être renvoyées. La valeur par défaut est false. Si vous définissez ce paramètre sur true, la réponse inclut AccessStrategyNum (le nombre de stratégies d'accès) et AddressPoolNum (le nombre de pools d'adresses).	false

Éléments de réponse

Élément	Type	Description	Exemple
	object
ExpireTimestamp	integer	L'heure d'expiration de l'instance. Il s'agit d'un horodatage UNIX.	1528284856000
UserDomainName	string	Le nom de domaine personnalisé.	dns-example.top
RequestId	string	L'identifiant unique de la requête.	E41AA251-F9BA-48C6-99B2-2B82B26A573A
LbaStrategy	string	La stratégie d'équilibrage de charge. ALL_RR : round-robin RATIO : round-robin pondéré	RATIO
InstanceId	string	L'identifiant de l'instance GTM.	gtm-cn-wwo3a3hbz**
CreateTime	string	L'heure de création de l'instance.	2018-06-06T11:34Z
CnameMode	string	Le mode d'accès CNAME. Valeurs valides : SYSTEM_ASSIGN : Le système attribue un nom de domaine. CUSTOM : Vous utilisez un nom de domaine personnalisé.	CUSTOM
Ttl	integer	Le TTL global.	60
Cname	string	Le nom de domaine d'accès CNAME.	gtm-cn-wwo3a3hbz**.dns-example.top
InstanceName	string	Le nom de l'instance.	test
VersionCode	string	Le code de version.	biaozhun
AlertGroup	string	Le groupe de contacts d'alerte.	["日常测试-研发组"]
AddressPoolNum	integer	Le nombre de pools d'adresses.	5
AccessStrategyNum	integer	Le nombre de stratégies d'accès.	5
ExpireTime	string	L'heure d'expiration de l'instance.	2018-06-06T11:34Z
CreateTimestamp	integer	L'heure de création de l'instance. Il s'agit d'un horodatage UNIX.	1528284856000
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-testgroupid

Exemples

JSON format

{
  "ExpireTimestamp": 1528284856000,
  "UserDomainName": "dns-example.top",
  "RequestId": "E41AA251-F9BA-48C6-99B2-2B82B26A573A",
  "LbaStrategy": "RATIO",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "CreateTime": "2018-06-06T11:34Z",
  "CnameMode": "CUSTOM",
  "Ttl": 60,
  "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top",
  "InstanceName": "test",
  "VersionCode": "biaozhun",
  "AlertGroup": "[\\\"日常测试-研发组\\\"]",
  "AddressPoolNum": 5,
  "AccessStrategyNum": 5,
  "ExpireTime": "2018-06-06T11:34Z",
  "CreateTimestamp": 1528284856000,
  "ResourceGroupId": "rg-testgroupid"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.