ListSites - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Consulte la liste des sites de l'utilisateur actuel, y compris des informations telles que le nom du site, l'état et la configuration.

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.

esa:ListSites

list

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SiteName	string	Non	Le nom du site. Utilisé comme condition de filtrage pour la requête.	example.com
SiteSearchType	string	Non	Le mode de correspondance de recherche pour le nom du site. Valeur par défaut : exact. Valeurs valides : prefix : correspondance de préfixe suffix : correspondance de suffixe exact : correspondance exacte fuzzy : correspondance approximative	fuzzy
PageNumber	integer	Non	Le paramètre de numéro de page pour la pagination dans une requête paginée. La valeur doit être supérieure ou égale à 1.	1
PageSize	integer	Non	Le nombre d'entrées par page pour la pagination dans une requête paginée. Valeurs valides : 1 à 500.	20
TagFilter	array<object>	Non	Les règles de filtrage des balises.
	object	Non
Key	string	Non	La clé de balise. Utilisée comme condition de filtrage pour la requête.	tag1
Value	string	Non	La valeur de balise. Utilisée comme condition de filtrage pour la requête.	aaa
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Utilisé comme condition de filtrage pour la requête.	rg-aekzd3styujvyei
Status	string	Non	L'état du site. Utilisé comme condition de filtrage pour la requête.	pending
OnlyEnterprise	boolean	Non	Indique si seuls les sites de l'édition Enterprise doivent être interrogés. Si vous définissez ce paramètre sur true, seuls les sites de l'édition Enterprise sont interrogés.	false
PlanSubscribeType	string	Non	Le type de plan d'abonnement. Valeurs valides : basicplan : édition basique standardplan : édition standard advancedplan : édition avancée enterpriseplan : édition Enterprise	basicplan
Coverage	string	Non	La région d'accélération. Valeurs valides : domestic : Chine continentale global : mondial overseas : mondial (hors Chine continentale)	global
AccessType	string	Non	Le type d'accès. Valeurs valides : NS : accès par hébergement NS CNAME : accès CNAME	NS
OrderBy	string	Non	Le champ de tri. Par défaut, les sites sont triés par heure de création. Valeurs valides : gmtCreate : heure de création du site visitTime : heure d'accès au site	visitTime

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	Le numéro de page des données renvoyées.	1
PageSize	integer	Le nombre de sites affichés par page.	20
TotalCount	integer	Le nombre total de sites.	40
Sites	array<object>	La liste des sites interrogés.
	array<object>
AccessType	string	Le type d'accès au site. Valeurs valides : NS : accès NS CNAME : accès CNAME	NS
CnameZone	string	Le suffixe CNAME du site. Pour les sites accessibles via CNAME, ce champ enregistre le suffixe CNAME qui doit être configuré.	example.cname.com
Coverage	string	La région d'accélération du site. Valeurs valides : domestic : Chine continentale global : mondial overseas : mondial (hors Chine continentale)	domestic
CreateTime	string	L'heure de création du site. L'heure est affichée en UTC et formatée conformément à la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ.	2023-12-24T02:01:11Z
UpdateTime	string	L'heure de mise à jour du site. L'heure est affichée en UTC et formatée conformément à la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ.	2023-12-24T02:01:11Z
InstanceId	string	L'identifiant d'instance du plan que vous associez au site.	onBvtlmIyeXLbiDw81F9
NameServerList	string	La liste des serveurs de noms attribués au site. Plusieurs serveurs de noms sont séparés par des virgules (,).	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	Le nom du plan.	plan-168656498****
PlanSpecName	string	Le nom de la spécification du plan du site.	normal
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-aek26g6i6se6pna
SiteId	integer	L'identifiant du site.	123456789****
SiteName	string	Le nom du site.	example.com
Status	string	L'état du site. Valeurs valides : pending : Le site est en attente de configuration. active : Le site est activé. offline : Le site est hors ligne. moved : Le site a été remplacé.	pending
Tags	object	Les balises du site.	{"tag1":"value1"}
VerifyCode	string	Le code de vérification de la propriété du site. Lorsqu'un site est accessible via CNAME, il s'agit du code de vérification TXT qui doit être configuré.	verify_d516cb3740f81f0cef77d162edd1****
VisitTime	string	L'heure d'accès au site. L'heure est affichée en UTC et formatée conformément à la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ.	2023-12-24T02:01:11Z
OfflineReason	string	La raison pour laquelle le site est désactivé. Valeurs valides : expiration_ arrears : Le plan auquel vous êtes abonné a expiré ou le compte présente un paiement en retard. internally_disabled : Le site est désactivé par le système. missing_icp : Le nom de domaine ne dispose pas de dépôt ICP. content_violation : Le site est désactivé en raison d'une violation de contenu. proactively_disabled : Vous avez désactivé le site de manière proactive ou le site est désactivé car il a atteint le plafond d'utilisation configuré.	expiration_ arrears

Exemples

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 40,
  "Sites": [
    {
      "AccessType": "NS",
      "CnameZone": "example.cname.com",
      "Coverage": "domestic",
      "CreateTime": "2023-12-24T02:01:11Z",
      "UpdateTime": "2023-12-24T02:01:11Z",
      "InstanceId": "onBvtlmIyeXLbiDw81F9",
      "NameServerList": "male1-1.ialicdn.com,female1-1.ialicdn.com",
      "PlanName": "plan-168656498****",
      "PlanSpecName": "normal",
      "ResourceGroupId": "rg-aek26g6i6se6pna",
      "SiteId": 0,
      "SiteName": "example.com",
      "Status": "pending",
      "Tags": {
        "tag1": "value1"
      },
      "VerifyCode": "verify_d516cb3740f81f0cef77d162edd1****",
      "VisitTime": "2023-12-24T02:01:11Z",
      "OfflineReason": "expiration_ arrears"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Échec de l'appel au service. Réessayez plus tard ou contactez le service client pour plus de détails.

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

Notes de version

Consultez Notes de version pour la liste complète.