DescribeSecurityGroups - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Tenez compte des points suivants :

Les informations de base des groupes de sécurité incluent leurs ID et descriptions. La réponse renvoie les groupes de sécurité par ordre décroissant de leurs ID.
Nous vous recommandons d'utiliser les paramètres MaxResults et NextToken pour une requête paginée. Utilisez MaxResults pour spécifier le nombre maximal d'entrées à renvoyer dans chaque requête. La valeur de retour de NextToken est un jeton de pagination utilisable dans la requête suivante pour récupérer une nouvelle page de résultats. Lors de la requête suivante, définissez NextToken sur la valeur NextToken renvoyée lors de l'appel précédent et utilisez MaxResults pour spécifier le nombre maximal d'entrées à renvoyer. Si la valeur de retour de NextToken est vide, la page de résultats actuelle est la dernière et aucun autre résultat ne sera renvoyé.
Lorsque vous utilisez Alibaba Cloud CLI pour appeler une opération d'API, vous devez spécifier les valeurs des paramètres de requête de différents types de données dans les formats requis. Pour plus d'informations, consultez Présentation du format des paramètres.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeSecurityGroups	L'opération que vous souhaitez effectuer. Définissez la valeur sur DescribeSecurityGroups.
RegionId	String	Yes	cn-hangzhou	L'ID de région du groupe de sécurité. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.
SecurityGroupIds	String	No	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]	Les ID des groupes de sécurité. La valeur est un tableau JSON composé d'un maximum de 100 ID de groupes de sécurité. Séparez les ID des groupes de sécurité par des virgules (,).
VpcId	String	No	vpc-bp67acfmxazb4p****	L'ID du Virtual Private Cloud (VPC) auquel appartient le groupe de sécurité.
SecurityGroupType	String	No	normal	Le type du groupe de sécurité. Valeurs possibles : normal : groupe de sécurité de base enterprise : groupe de sécurité avancé Remarque Si vous ne spécifiez pas ce paramètre, les groupes de sécurité de base et avancés sont interrogés.
NextToken	String	No	e71d8a535bd9cc11	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Vous n'avez pas besoin de spécifier ce paramètre pour la première requête. Spécifiez le jeton obtenu à partir de la requête précédente comme valeur de NextToken.
MaxResults	Integer	No	10	Le nombre maximal d'entrées par page. Si vous spécifiez MaxResults, `MaxResults` et `NextToken` sont utilisés pour une requête paginée. Valeurs possibles : 1 à 100. Valeur par défaut : 10.
NetworkType	String	No	vpc	Le type de réseau du groupe de sécurité. Valeurs possibles : vpc classic
SecurityGroupName	String	No	SGTestName	Le nom du groupe de sécurité.
IsQueryEcsCount	Boolean	No	null	Indique s'il faut interroger la capacité du groupe de sécurité. Si vous définissez ce paramètre sur True, les valeurs `EcsCount` et `AvailableInstanceAmount` dans la réponse sont valides. Remarque Ce paramètre n'est plus utilisé.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	L'ID du groupe de ressources auquel appartient le groupe de sécurité. Si ce paramètre est spécifié pour interroger des ressources, un maximum de 1 000 ressources appartenant au groupe de ressources spécifié peuvent être affichées dans la réponse. Vous pouvez appeler l'opération ListResourceGroups pour interroger la liste la plus récente des groupes de ressources. Remarque Les ressources du groupe de ressources par défaut sont affichées dans la réponse, quelle que soit la valeur de ce paramètre.
Tag.N.key	String	No	testkey	La clé du tag N du groupe de sécurité. Remarque Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser le paramètre Tag.N.Key pour assurer la compatibilité future.
Tag.N.Key	String	No	TestKey	La clé du tag N du groupe de sécurité. Valeurs possibles de N : 1 à 20. Si un seul tag est spécifié pour interroger des ressources, un maximum de 1 000 ressources ayant ce tag ajouté sont renvoyées. Si plusieurs tags sont spécifiés pour interroger des ressources, un maximum de 1 000 ressources ayant tous ces tags ajoutés sont renvoyées. Pour interroger plus de 1 000 ressources ayant les tags spécifiés ajoutés, appelez l'opération ListTagResources.
Tag.N.Value	String	No	TestValue	La valeur du tag. Valeurs possibles de N : 1 à 20.
Tag.N.value	String	No	testvalue	La valeur du tag N du groupe de sécurité. Remarque Ce paramètre sera déprécié à l'avenir. Nous vous recommandons d'utiliser le paramètre Tag.N.Value pour assurer la compatibilité future.
DryRun	Boolean	No	false	Indique s'il faut effectuer uniquement un test à blanc, sans exécuter la requête réelle. Valeurs possibles : true : effectue uniquement un test à blanc. Le système vérifie la paire AccessKey, les autorisations de l'utilisateur Resource Access Management (RAM) et les paramètres requis. Si la requête échoue au test à blanc, un message d'erreur est renvoyé. Sinon, le code d'erreur DryRunOperation est renvoyé. false : effectue un test à blanc et exécute la requête réelle. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée. Valeur par défaut : false.
SecurityGroupId	String	No	sg-bp67acfmxazb4p****	L'ID du groupe de sécurité.
FuzzyQuery	Boolean	No	null	Remarque Ce paramètre n'est plus utilisé.
PageNumber	Integer	No	1	Le numéro de page. Les pages commencent à partir de la page 1. Valeur par défaut : 1. Remarque Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser les paramètres NextToken et MaxResults pour une requête paginée.
PageSize	Integer	No	10	Le nombre d'entrées par page. Valeurs possibles : 1 à 50. Valeur par défaut : 10. Remarque Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser les paramètres NextToken et MaxResults pour une requête paginée.
ServiceManaged	Boolean	No	false	Indique s'il faut interroger les groupes de sécurité gérés. Valeurs possibles : true false

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	L'ID de la requête.
RegionId	String	cn-hangzhou	L'ID de région du groupe de sécurité.
NextToken	String	e71d8a535bd9cc11	Un jeton de pagination. Il peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Si la valeur de retour de ce paramètre est vide lorsque vous spécifiez MaxResults et NextToken pour une requête paginée, aucun autre résultat ne sera renvoyé.
SecurityGroups	Array of SecurityGroup		Détails sur les groupes de sécurité.
SecurityGroup
SecurityGroupId	String	sg-bp67acfmxazb4p****	L'ID du groupe de sécurité.
SecurityGroupName	String	SGTestName	Le nom du groupe de sécurité.
Description	String	TestDescription	La description du groupe de sécurité.
SecurityGroupType	String	normal	Le type du groupe de sécurité. Valeurs possibles : normal : groupe de sécurité de base enterprise : groupe de sécurité avancé
VpcId	String	vpc-bp67acfmxazb4p****	L'ID du VPC auquel appartient le groupe de sécurité.
CreationTime	String	2021-08-31T03:12:29Z	L'heure de création du groupe de sécurité. L'heure suit la norme ISO 8601 au format yyyy-MM-ddThh:mmZ. L'heure est affichée en UTC.
EcsCount	Integer	0	Le nombre d'adresses IP privées contenues dans le groupe de sécurité. Pour plus d'informations, consultez la section « Capacité du groupe de sécurité » dans Groupes de sécurité de base et groupes de sécurité avancés. Si vous définissez IsQueryEcsCount sur True, la valeur du paramètre dans la réponse est valide. Remarque Ce paramètre n'est plus utilisé. La quantité renvoyée est fournie à titre indicatif uniquement. La quantité réelle peut différer de la quantité renvoyée.
AvailableInstanceAmount	Integer	0	Le nombre d'adresses IP privées pouvant être ajoutées au groupe de sécurité. Pour plus d'informations, consultez la section « Capacité du groupe de sécurité » dans Groupes de sécurité de base et groupes de sécurité avancés. Si vous définissez IsQueryEcsCount sur True, la valeur du paramètre dans la réponse est valide. Remarque Ce paramètre n'est plus utilisé. La quantité renvoyée est fournie à titre indicatif uniquement. La quantité réelle peut différer de la quantité renvoyée.
ResourceGroupId	String	rg-bp67acfmxazb4p****	L'ID du groupe de ressources auquel appartient le groupe de sécurité.
ServiceManaged	Boolean	false	Indique si l'utilisateur du groupe de sécurité est un service Alibaba Cloud ou un distributeur.
ServiceID	Long	12345678910	L'ID du distributeur auquel appartient le groupe de sécurité.
Tags	Array of Tag		Les tags du groupe de sécurité.
Tag
TagValue	String	TestValue	La valeur du tag.
TagKey	String	TestKey	La clé du tag.
TotalCount	Integer	20	Le nombre total de groupes de sécurité. Si `MaxResults` et `NextToken` sont spécifiés dans la requête, la valeur de ce paramètre n'est pas renvoyée.
PageNumber	Integer	1	Le numéro de page. Remarque Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser les paramètres NextToken et MaxResults pour une requête paginée.
PageSize	Integer	10	Le nombre d'entrées par page. Remarque Ce paramètre sera supprimé à l'avenir. Nous vous recommandons d'utiliser les paramètres NextToken et MaxResults pour une requête paginée.

Exemples

Exemples de requêtes

http(s)://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&MaxResults=10
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecurityGroupsResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>20</TotalCount>
    <RegionId>cn-hangzhou</RegionId>
    <SecurityGroups>
        <CreationTime>2021-08-31T03:12:29Z</CreationTime>
        <VpcId>vpc-bp67acfmxazb4p****</VpcId>
        <ServiceManaged>false</ServiceManaged>
        <Description>TestDescription</Description>
        <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
        <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
        <SecurityGroupName>SGTestName</SecurityGroupName>
        <EcsCount>0</EcsCount>
        <ServiceID>12345678910</ServiceID>
        <SecurityGroupType>normal</SecurityGroupType>
        <AvailableInstanceAmount>0</AvailableInstanceAmount>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
    </SecurityGroups>
    <NextToken>e71d8a535bd9cc11</NextToken>
</DescribeSecurityGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	PageNumber et PageSize ne sont pas pris en charge. Utilisez NextToken et MaxResults à la place.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	Valeur NextToken non valide.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	RegionId est requis.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	Valeur SecurityGroupType non valide.
500	InternalError	The request processing has failed due to some unknown error.	Une erreur interne s'est produite. Réessayez ultérieurement.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.