DescribeGroupedContainerInstances - Security Center - Centre de documentation Alibaba Cloud

Consulte la liste des conteneurs en fonction du type de groupe spécifié.

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.

yundun-sas:DescribeGroupedContainerInstances

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Criteria	string	Non	Les conditions de recherche des actifs. Ce paramètre est au format JSON. Séparez les conditions multiples par des virgules (,). Exemple : [{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]. Remarque Vous pouvez rechercher des actifs par identifiant d'instance, nom d'instance, identifiant de VPC, région, adresse IP publique et autres conditions. Appelez DescribeCriteria pour interroger les conditions de recherche prises en charge.	[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]
LogicalExp	string	Non	La relation logique entre plusieurs conditions de recherche. Valeurs valides : OR : les conditions de recherche sont évaluées avec un OU logique. AND : les conditions de recherche sont évaluées avec un ET logique.	OR
GroupField	string	Oui	Le type de groupe à interroger. Valeurs valides : pod : pod appName : nom de l'application namespace : espace de noms clusterId : identifiant du cluster image : image.	pod.
FieldValue	string	Non	La condition de recherche pour le type de groupe spécifié. Définissez la condition de recherche en fonction du type spécifié par GroupField : Si GroupField est défini sur pod : spécifiez le nom du pod à interroger. Si GroupField est défini sur appName : spécifiez le nom de l'application à interroger. Si GroupField est défini sur namespace : spécifiez l'espace de noms à interroger. Si GroupField est défini sur clusterId : spécifiez l'identifiant du cluster à interroger. Si GroupField est défini sur image : spécifiez le nom de l'image à interroger. Remarque Toutes les conditions de recherche précédentes prennent en charge la correspondance approximative.	cas-adad-qeqwe.
PageSize	integer	Non	Le nombre d'actifs de conteneurs à afficher sur chaque page lorsque la pagination est utilisée. Valeur par défaut : 20, ce qui indique que 20 actifs de conteneurs sont affichés sur chaque page. Remarque Ne laissez pas PageSize vide.	20
CurrentPage	integer	Non	Le numéro de la page à renvoyer. Valeur par défaut : 1, ce qui indique que la première page est renvoyée.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête. Il s'agit d'un identifiant unique généré par Alibaba Cloud pour la requête et qui peut être utilisé pour résoudre les problèmes.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D.
PageInfo	object	Les informations de pagination.
CurrentPage	integer	Le numéro de la page actuelle dans une requête paginée.	1
PageSize	integer	Le nombre d'actifs de conteneurs affichés sur chaque page dans une requête paginée. Valeur par défaut : 20, ce qui indique que 20 actifs de conteneurs sont affichés sur chaque page.	20
TotalCount	integer	Le nombre total d'actifs de conteneurs renvoyés.	25
Count	integer	Le nombre d'actifs de conteneurs affichés sur la page actuelle dans une requête paginée.	20
GroupedContainerInstanceList	array<object>	La liste des informations sur les actifs de conteneurs renvoyée.
	object	Les informations sur les actifs de conteneurs.
RiskLevel	string	Le niveau de risque. Valeurs valides : high : élevé medium : moyen low : faible.	low.
HostIp	string	L'adresse IP de l'hôte du cluster de conteneurs.	172.114.XX.XX
Pod	string	Le nom du pod.	csi-plugin-2n****
RiskStatus	string	Le statut de risque. Valeurs valides : NO : aucun risque. YES : à risque.	NO
CreateTime	integer	L'horodatage de la création du cluster, en millisecondes.	1600076893000
Namespace	string	L'espace de noms du cluster.	kube-system.
CusterState	string	L'état d'exécution du cluster. Valeurs valides : running : le cluster est en cours d'exécution. stopped : le cluster est arrêté. deleted : le cluster est supprimé. delete_failed : la suppression du cluster a échoué. failed : la création du cluster a échoué.	running.
InstanceId	string	L'identifiant de l'instance de serveur.	i-8vb9ul5xec4tua4q****
RegionId	string	L'identifiant de la région dans laquelle réside l'instance.	cn-hangzhou.
AppName	string	Le nom de l'application.	oss-liveness-probe.
InstanceCount	integer	Le nombre de pods, d'applications, de clusters ou d'espaces de noms renvoyés.	9
ClusterType	string	Le type de cluster. Valeurs valides : Kubernetes : cluster Kubernetes dédié ManagedKubernetes : cluster géré standard (cluster de périphérie) Ask : cluster sans serveur standard.	ManagedKubernetes.
ClusterName	string	Le nom du cluster.	test.
PodIp	string	L'adresse IP du pod.	172.114.XX.XX
VulCount	integer	Le nombre de vulnérabilités détectées dans le pod, l'application, l'espace de noms ou le cluster actuel.	1
AlarmCount	integer	Le nombre d'alertes détectées dans le pod, l'application, l'espace de noms ou le cluster actuel.	1
RiskInstanceCount	integer	Le nombre d'instances à risque.	1
ClusterId	string	L'identifiant du cluster.	cf3824769c85441b4bf3****
Image	string	L'image de conteneur.	registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77
ImageRepoNamespace	string	L'espace de noms du référentiel d'images.	name001
ImageRepoName	string	Le nom du référentiel d'images.	test-003
ImageRepoTag	string	La balise du référentiel d'images.	dev-20220512-2
ImageDigest	string	La valeur de l'empreinte de l'image.	58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf.
ImageUuid	string	L'UUID de l'image.	e4bdec1d9ba7e0967111a7ea467c****
HcCount	integer	Le nombre total de vérifications de référence détectées dans le pod, l'application, l'espace de noms ou le cluster actuel.	20
SyncOpen	integer	L'état d'activation de la synchronisation de l'audit des logs pour le cluster. Valeurs valides : 0 : désactivé 1 : activé.	1
SyncStatus	integer	L'état de synchronisation de l'audit des logs pour le cluster. Valeurs valides : 0 : échec de la synchronisation 1 : synchronisation réussie.	1

Exemples

JSON format

{
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25,
    "Count": 20
  },
  "GroupedContainerInstanceList": [
    {
      "RiskLevel": "low",
      "HostIp": "172.114.XX.XX",
      "Pod": "csi-plugin-2n****",
      "RiskStatus": "NO",
      "CreateTime": 1600076893000,
      "Namespace": "kube-system",
      "CusterState": "running",
      "InstanceId": "i-8vb9ul5xec4tua4q****",
      "RegionId": "cn-hangzhou",
      "AppName": "oss-liveness-probe",
      "InstanceCount": 9,
      "ClusterType": "ManagedKubernetes",
      "ClusterName": "test",
      "PodIp": "172.114.XX.XX",
      "VulCount": 1,
      "AlarmCount": 1,
      "RiskInstanceCount": 1,
      "ClusterId": "cf3824769c85441b4bf3****",
      "Image": "registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77",
      "ImageRepoNamespace": "name001",
      "ImageRepoName": "test-003",
      "ImageRepoTag": "dev-20220512-2",
      "ImageDigest": "58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf",
      "ImageUuid": "e4bdec1d9ba7e0967111a7ea467c****",
      "HcCount": 20,
      "SyncOpen": 1,
      "SyncStatus": 1
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

Notes de version

Consultez Notes de version pour la liste complète.