DescribeSecurityGroups - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les informations de base des groupes de sécurité. Vous pouvez filtrer les résultats par région, identifiant de groupe de sécurité, type de groupe de sécurité et autres paramètres lors de la requête.

Description de l'opération

Requête paginée : utilisez MaxResults et NextToken pour la requête paginée.

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.

ecs:DescribeSecurityGroups

get

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/*

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}

ecs:tag
ecs:tag
ecs:tag
ecs:tag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
SecurityGroupIds	string	Non	Les identifiants des groupes de sécurité. Vous pouvez spécifier jusqu'à 100 identifiants de groupes de sécurité. Séparez les identifiants multiples par des virgules (,) au format de tableau JSON.	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]
VpcId	string	Non	L'identifiant du cloud privé virtuel (VPC) auquel le groupe de sécurité appartient.	vpc-bp67acfmxazb4p****
SecurityGroupType	string	Non	Le type du groupe de sécurité. Valeurs valides :	normal
NextToken	string	Non	Le jeton de pagination. Définissez ce paramètre sur la valeur NextToken renvoyée dans la requête précédente. Vous n'avez pas besoin de définir ce paramètre pour la première requête.	e71d8a535bd9cc11
MaxResults	integer	Non	Le nombre maximal d'entrées par page pour la requête paginée. Si vous définissez ce paramètre, la méthode de pagination MaxResults et NextToken est utilisée.	10
NetworkType	string	Non	Le type de réseau du groupe de sécurité. Valeurs valides :	vpc
SecurityGroupName	string	Non	Le nom du groupe de sécurité.	SGTestName
IsQueryEcsCount	boolean	Non	Indique si les informations de capacité du groupe de sécurité doivent être interrogées. Si vous définissez ce paramètre sur True, les valeurs EcsCount et AvailableInstanceAmount dans la réponse sont valides.	null
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le groupe de sécurité appartient. Lorsque vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources ne peut pas dépasser 1 000. Vous pouvez appeler ListResourceGroups pour interroger les groupes de ressources.	rg-bp67acfmxazb4p****
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
key	string	Non	La clé de balise du groupe de sécurité.	testkey
Key	string	Non	La clé de balise du groupe de sécurité. Valeurs valides de N : 1 à 20.	TestKey
Value	string	Non	La valeur de balise du groupe de sécurité. Valeurs valides de N : 1 à 20.	TestValue
value	string	Non	La valeur de balise du groupe de sécurité.	testvalue
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué. Valeurs valides :	false
SecurityGroupId	string	Non	L'identifiant du groupe de sécurité.	sg-bp67acfmxazb4p****
FuzzyQuery	boolean	Non	Remarque Ce paramètre est obsolète.	null
PageNumber	integer	Non	Remarque Ce paramètre sera mis hors ligne. Utilisez NextToken et MaxResults pour la pagination.	1
PageSize	integer	Non	Remarque Ce paramètre sera mis hors ligne. Utilisez NextToken et MaxResults pour la pagination.	10
ServiceManaged	boolean	Non	Indique si le groupe de sécurité managé est administré. Valeurs valides :	false

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionId	string	L'identifiant de la région du groupe de sécurité.	cn-hangzhou
NextToken	string	Le jeton de pagination renvoyé dans cet appel. Si cette valeur est vide lorsque vous utilisez MaxResults et NextToken pour la pagination, aucune autre donnée n'est disponible.	e71d8a535bd9cc11
SecurityGroups	object
SecurityGroup	array<object>	L'ensemble des informations sur les groupes de sécurité.
	array<object>	Les informations du groupe de sécurité.
SecurityGroupId	string	The security group ID.	sg-bp67acfmxazb4p****
SecurityGroupName	string	The name of the security group.	SGTestName
Description	string	The description of the security group.	TestDescription
SecurityGroupType	string	The type of the security group. Valid values: normal: basic security group. enterprise: advanced security group.	normal
VpcId	string	The VPC to which the security group belongs.	vpc-bp67acfmxazb4p****
CreationTime	string	The time when the security group was created. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddThh:mmZ.	2021-08-31T03:12:29Z
EcsCount	integer	The number of private IP addresses in the security group. For more information, see Security group capacity. This parameter is valid only when IsQueryEcsCount is set to True. Remarque This parameter is deprecated. The returned value is for reference only and is not guaranteed to be real-time consistent.	0
AvailableInstanceAmount	integer	The number of private IP addresses that can be added to the security group. For more information, see Security group capacity. This parameter is valid only when IsQueryEcsCount is set to True. Remarque This parameter is deprecated. The returned value is for reference only and is not guaranteed to be real-time consistent.	0
ResourceGroupId	string	The ID of the resource group to which the security group belongs.	rg-bp67acfmxazb4p****
ServiceManaged	boolean	Indicates whether the security group is used by a cloud service or a Virtual Network Operator (VNO).	false
ServiceID	integer	The VNO ID associated with the security group.	12345678910
Tags	object
Tag	array<object>	The collection of tags for the security group.
	object	The tag of the security group.
TagValue	string	The tag value of the security group.	TestValue
TagKey	string	The tag key of the security group.	TestKey
RuleCount	integer	The number of rules in the security group.	100
GroupToGroupRuleCount	integer	The number of rules that authorize access from other security groups.	5
TotalCount	integer	Le nombre total de groupes de sécurité. Ce paramètre n'est pas renvoyé lorsque vous utilisez MaxResults et NextToken pour la requête de paramètres.	20
PageNumber	integer	Le numéro de la page actuelle.	1
PageSize	integer	Le nombre d'entrées par page.	10

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RegionId": "cn-hangzhou",
  "NextToken": "e71d8a535bd9cc11",
  "SecurityGroups": {
    "SecurityGroup": [
      {
        "SecurityGroupId": "sg-bp67acfmxazb4p****",
        "SecurityGroupName": "SGTestName",
        "Description": "TestDescription",
        "SecurityGroupType": "normal",
        "VpcId": "vpc-bp67acfmxazb4p****",
        "CreationTime": "2021-08-31T03:12:29Z",
        "EcsCount": 0,
        "AvailableInstanceAmount": 0,
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServiceManaged": false,
        "ServiceID": 12345678910,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RuleCount": 100,
        "GroupToGroupRuleCount": 5
      }
    ]
  },
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	The PageNumber and PageSize parameters are no longer supported. Use the NextToken and MaxResults parameters instead.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	The specified NextToken parameter is invalid.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	The RegionId parameter is required.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	The specified SecurityGroupType parameter is invalid.
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.	The specified SecurityGroupId parameter is invalid.
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.	The specified SecurityGroupName parameter is not valid. This parameter is empty by default. If you specify a security group name, the name must be 2 to 128 characters in length and start with a letter. It can contain letters, digits, periods (.), underscores (_), and hyphens (-) and cannot start with http:// or https. The security group name is displayed in the ECS console.
500	InternalError	The request processing has failed due to some unknown error.

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

Notes de version

Consultez Notes de version pour la liste complète.