SearchCloudGtmAddresses - - Centre de documentation Alibaba Cloud

Recherche des adresses en fonction de critères tels que le nom de l'adresse, les remarques, le modèle de contrôle de santé référencé ou l'identifiant de l'adresse.

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

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AcceptLanguage	string	Non	La langue de la valeur de retour. Valeurs valides : zh-CN : chinois. en-US : anglais. Il s'agit de la valeur par défaut.	en-US
Names	array	Non	Le nom de l'adresse. Ce nom est utilisé pour une identification facile.
	string	Non	Les conditions de recherche pour le nom de l'adresse. Vous pouvez saisir plusieurs mots-clés pour une requête.	["address_1", "test"]
NameSearchCondition	string	Non	La logique de recherche pour les requêtes par nom d'adresse. Ce paramètre est requis lorsque vous effectuez une requête par nom d'adresse. and : la requête renvoie les résultats qui correspondent à tous les mots-clés spécifiés. or : la requête renvoie les résultats qui correspondent à certains ou à tous les mots-clés spécifiés.	or
AvailableStatus	string	Non	Effectue une recherche exacte par état de disponibilité de l'adresse. available : l'adresse est disponible. unavailable : l'adresse n'est pas disponible.	available
Type	string	Non	Effectue une recherche exacte par type d'adresse. IPv4 IPv6 domain	IPv4
Address	string	Non	Effectue une recherche exacte par point de terminaison. Les adresses IP et les noms de domaine sont pris en charge.	223.5.XX.XX
MonitorTemplateName	string	Non	Le nom du modèle de contrôle de santé.	Ping-IPv4
EnableStatus	string	Non	Effectue une recherche exacte par état de l'adresse. enable : l'adresse est activée. disable : l'adresse est désactivée.	enable
HealthStatus	string	Non	Effectue une recherche exacte par état de santé de l'adresse. ok : toutes les tâches de contrôle de santé pour le modèle de contrôle de santé référencé sont normales. ok_alert : certaines tâches de contrôle de santé pour le modèle de contrôle de santé référencé sont anormales, mais l'adresse est toujours considérée comme normale. ok_no_monitor : l'adresse ne référence aucun modèle de contrôle de santé. exceptional : certaines ou toutes les tâches de contrôle de santé pour le modèle de contrôle de santé référencé sont anormales, et l'adresse est considérée comme anormale.	ok
Remarks	array	Non	Les remarques pour l'adresse.
	string	Non	Les conditions de recherche pour les remarques de l'adresse. Vous pouvez saisir plusieurs mots-clés pour une requête.	["", "test"]
RemarkSearchCondition	string	Non	La logique de recherche pour les requêtes par remarques d'adresse. Ce paramètre est requis lorsque vous effectuez une requête par remarques d'adresse. and : la requête renvoie les résultats qui correspondent à tous les mots-clés spécifiés. or : la requête renvoie les résultats qui correspondent à certains ou à tous les mots-clés spécifiés.	or
PageNumber	integer	Oui	Le numéro de page actuel. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Oui	Le nombre d'entrées à renvoyer sur chaque page pour une requête paginée. La valeur maximale est 100. La valeur par défaut est 20.	20
AddressId	string	Non	L'identifiant de l'adresse. L'identifiant de l'adresse est un identifiant unique.	addr-89518218114368****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant unique de la requête.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	Le numéro de page actuel. La valeur commence à 1. La valeur par défaut est 1.	1
PageSize	integer	Le nombre d'entrées renvoyées sur chaque page pour une requête paginée. 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 d'adresses qui répondent aux conditions de la requête.	15
Addresses	object
Address	array<object>	La liste des adresses.
	array<object>	La liste des adresses.
AddressId	string	The ID of the address. The address ID is a unique identifier.	addr-89518218114368**92
CreateTime	string	The time when the address was created.	2024-03-23T13:09Z
CreateTimestamp	integer	The timestamp that indicates when the address was created.	1527690629357
UpdateTime	string	The time when the address was last modified.	2024-03-29T13:20Z
UpdateTimestamp	integer	The timestamp that indicates when the address was last modified.	1527690629357
Name	string	The name of the address.	Address-1
Type	string	The type of the address: IPv4: an IPv4 address IPv6: an IPv6 address domain: a domain name	IPv4
Address	string	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	The attribution information of the address. This parameter is not supported in the current version.	当前版本不返回此参数。
Remark	string	The remarks.	test
EnableStatus	string	The current status of the address: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	The switchover mode for the address that is triggered when a health check exception occurs: auto: automatic mode. In this mode, the system determines whether to stop or resume DNS resolution for the address based on the health check result. If the health check result is abnormal, the system stops DNS resolution. If the health check result is normal, the system resumes DNS resolution. manual: manual mode. In this mode, if the address is in the abnormal state, the system stops DNS resolution. DNS resolution is not resumed even if the health check result is normal. If the address is in the normal state, the system resumes DNS resolution. If the health check result is abnormal, the system only sends an alert and does not stop DNS resolution.	auto
ManualAvailableStatus	string	The availability status that is configured for the address when `AvailableMode` is set to `manual`: available: normal. In this state, DNS resolution for the address is normal. If the health check result is abnormal, the system only sends an alert and does not stop DNS resolution. unavailable: abnormal. In this state, the system stops DNS resolution. DNS resolution is not resumed even if the health check result is normal.	available
AvailableStatus	string	The current availability status of the address. available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The result of the health check: ok: All health check tasks for the referenced health check template are normal. ok_alert: Some health check tasks for the referenced health check template are abnormal, but the address is still considered normal. ok_no_monitor: The address does not reference any health check templates. exceptional: Some or all health check tasks for the referenced health check template 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 health checks are normal. p50_ok: At least 50% of health checks are normal. p70_ok: At least 70% of health checks are normal. all_ok: All health checks are normal.	p50_ok
HealthTasks	object
HealthTask	array<object>	The list of health check tasks.
	object	The information about the health check tasks that the address references.
Port	integer	The service port of the destination address for the health check. You cannot configure a service port if the health check uses the Ping protocol.	80
TemplateId	string	The ID of the health check template that is associated with the address.	mtp-89518052425100****
TemplateName	string	The name of the health check template.	IPv4-Ping
MonitorStatus	string	The status of the health check task: ok: normal. alert: an alert is triggered. no_data: no data is available. This status typically occurs when a health check task is newly created and data has not been collected yet.	ok

Exemples

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368**92",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100****",
              "TemplateName": "IPv4-Ping",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.