DescribeSecurityGroups - - Alibaba Cloud Dokümantasyon Merkezi

Kullanım notları

Aşağıdaki hususlara dikkat edin:

Güvenlik gruplarının temel bilgileri arasında kimlikleri ve açıklamaları yer alır. Yanıtta güvenlik grupları, kimliklerine göre azalan sırada döndürülür.
Sayfalama sorgusu için MaxResults ve NextToken parametrelerini kullanmanızı öneririz. Her istekte döndürülecek maksimum girdi sayısını belirtmek üzere MaxResults parametresini kullanın. NextToken dönüş değeri bir sayfalama belirtecidir; bu belirteç, sonraki istekte yeni bir sonuç sayfası almak için kullanılabilir. Sonraki isteği gerçekleştirirken NextToken değerini önceki çağrıdan dönen NextToken değerine ayarlayın ve bu istekte döndürülecek maksimum girdi sayısını belirtmek için MaxResults parametresini kullanın. NextToken dönüş değeri boşsa mevcut sayfa son sayfadır ve daha fazla sonuç döndürülmez.
Alibaba Cloud CLI kullanarak bir API işlemini çağırdığınızda farklı veri türlerindeki istek parametre değerlerini gerekli biçimlerde belirtmeniz gerekir. Daha fazla bilgi için bkz. Parametre biçimine genel bakış.

Hata ayıklama

OpenAPI Explorer imza değerini otomatik olarak hesaplar. Kolaylık sağlaması amacıyla bu işlemi OpenAPI Explorer içinde çağırmanızı öneririz. OpenAPI Explorer, farklı SDK'lar için işlemin örnek kodunu dinamik olarak oluşturur.

İstek parametreleri

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeSecurityGroups	Gerçekleştirmek istediğiniz işlem. Değeri DescribeSecurityGroups olarak ayarlayın.
RegionId	String	Yes	cn-hangzhou	Güvenlik grubunun bölge kimliği. En güncel bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.
SecurityGroupIds	String	No	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]	Güvenlik grubu kimlikleri. Değer, en fazla 100 güvenlik grubu kimliğinden oluşan bir JSON dizisidir. Güvenlik grubu kimliklerini virgül (,) ile ayırın.
VpcId	String	No	vpc-bp67acfmxazb4p****	Güvenlik grubunun ait olduğu Virtual Private Cloud (VPC) kimliği.
SecurityGroupType	String	No	normal	Güvenlik grubunun türü. Geçerli değerler: normal: temel güvenlik grubu enterprise: gelişmiş güvenlik grubu Not Bu parametreyi belirtmezseniz hem temel hem de gelişmiş güvenlik grupları sorgulanır.
NextToken	String	No	e71d8a535bd9cc11	Sonraki istekte yeni bir sonuç sayfası almak için kullanılan sayfalama belirteci. İlk istek için bu parametreyi belirtmeniz gerekmez. Önceki sorgudan elde edilen belirteci NextToken değeri olarak belirtmeniz gerekir.
MaxResults	Integer	No	10	Sayfa başına maksimum girdi sayısı. MaxResults belirtirseniz `MaxResults` ve `NextToken` sayfalı sorgu için kullanılır. Geçerli değerler: 1 ile 100. Varsayılan değer: 10.
NetworkType	String	No	vpc	Güvenlik grubunun ağ türü. Geçerli değerler: vpc classic
SecurityGroupName	String	No	SGTestName	Güvenlik grubunun adı.
IsQueryEcsCount	Boolean	No	null	Güvenlik grubu kapasitesinin sorgulanıp sorgulanmayacağını belirtir. Bu parametreyi True olarak ayarlarsanız yanıtta dönen `EcsCount` ve `AvailableInstanceAmount` değerleri geçerli olur. Not Bu parametre artık kullanılmamaktadır.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	Güvenlik grubunun ait olduğu kaynak grubu kimliği. Kaynakları sorgulamak için bu parametre belirtilirse yanıtta belirtilen kaynak grubuna ait en fazla 1.000 kaynak görüntülenebilir. En güncel kaynak grubu listesini sorgulamak için ListResourceGroups işlemini çağırabilirsiniz. Not Bu parametrenin nasıl ayarlandığından bağımsız olarak varsayılan kaynak grubundaki kaynaklar yanıtta görüntülenir.
Tag.N.key	String	No	testkey	N. güvenlik grubu etiketinin anahtarı. Not Bu parametre gelecekte kaldırılacaktır. Gelecekteki uyumluluğu sağlamak için Tag.N.Key parametresini kullanmanızı öneririz.
Tag.N.Key	String	No	TestKey	N. güvenlik grubu etiketinin anahtarı. N için geçerli değerler: 1 ile 20. Kaynakları sorgulamak için tek bir etiket belirtilirse bu etikete sahip en fazla 1.000 kaynak döndürülür. Birden çok etiket belirtilerek kaynaklar sorgulanırsa tüm bu etiketlere sahip en fazla 1.000 kaynak döndürülür. Belirtilen etiketlere sahip 1.000'den fazla kaynağı sorgulamak için ListTagResources işlemini çağırın.
Tag.N.Value	String	No	TestValue	Etiketin değeri. N için geçerli değerler: 1 ile 20.
Tag.N.value	String	No	testvalue	N. güvenlik grubu etiketinin değeri. Not Bu parametre gelecekte kullanım dışı bırakılacaktır. Gelecekteki uyumluluğu sağlamak için Tag.N.Value parametresini kullanmanızı öneririz.
DryRun	Boolean	No	false	Yalnızca deneme çalıştırması yapılıp yapılmayacağını belirtir; gerçek istek gerçekleştirilmez. Geçerli değerler: true: yalnızca deneme çalıştırması yapılır. Sistem AccessKey çiftini, Resource Access Management (RAM) kullanıcısının izinlerini ve gerekli parametreleri kontrol eder. İstek deneme çalıştırmasında başarısız olursa bir hata iletisi döndürülür. Aksi takdirde DryRunOperation hata kodu döndürülür. false: deneme çalıştırması yapılır ve gerçek istek gerçekleştirilir. İstek deneme çalıştırmasını geçerse 2xx HTTP durum kodu döndürülür ve işlem yürütülür. Varsayılan değer: false.
SecurityGroupId	String	No	sg-bp67acfmxazb4p****	Güvenlik grubu kimliği.
FuzzyQuery	Boolean	No	null	Not Bu parametre artık kullanılmamaktadır.
PageNumber	Integer	No	1	Sayfa numarası. Sayfalar 1. sayfadan başlar. Varsayılan değer: 1. Not Bu parametre gelecekte kaldırılacaktır. Sayfalı sorgu için NextToken ve MaxResults parametrelerini kullanmanızı öneririz.
PageSize	Integer	No	10	Sayfa başına girdi sayısı. Geçerli değerler: 1 ile 50. Varsayılan değer: 10. Not Bu parametre gelecekte kaldırılacaktır. Sayfalı sorgu için NextToken ve MaxResults parametrelerini kullanmanızı öneririz.
ServiceManaged	Boolean	No	false	Yönetilen güvenlik gruplarının sorgulanıp sorgulanmayacağını belirtir. Geçerli değerler: true false

Yanıt parametreleri

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	İstek kimliği.
RegionId	String	cn-hangzhou	Güvenlik grubunun bölge kimliği.
NextToken	String	e71d8a535bd9cc11	Bir sayfalama belirteci. Sonraki istekte yeni bir sonuç sayfası almak için kullanılabilir. Sayfalı sorgu için MaxResults ve NextToken belirttiğinizde bu parametrenin dönüş değeri boşsa daha fazla sonuç döndürülmez.
SecurityGroups	Array of SecurityGroup		Güvenlik gruplarıyla ilgili ayrıntılar.
SecurityGroup
SecurityGroupId	String	sg-bp67acfmxazb4p****	Güvenlik grubu kimliği.
SecurityGroupName	String	SGTestName	Güvenlik grubunun adı.
Description	String	TestDescription	Güvenlik grubunun açıklaması.
SecurityGroupType	String	normal	Güvenlik grubunun türü. Geçerli değerler: normal: temel güvenlik grubu enterprise: gelişmiş güvenlik grubu
VpcId	String	vpc-bp67acfmxazb4p****	Güvenlik grubunun ait olduğu VPC kimliği.
CreationTime	String	2021-08-31T03:12:29Z	Güvenlik grubunun oluşturulma zamanı. Zaman, yyyy-MM-ddThh:mmZ biçiminde ISO 8601 standardını takip eder. Zaman UTC olarak gösterilir.
EcsCount	Integer	0	Güvenlik grubunda bulunan özel IP adreslerinin sayısı. Daha fazla bilgi için Temel güvenlik grupları ve gelişmiş güvenlik grupları bölümündeki "Güvenlik grubu kapasitesi" kısmına bakın. IsQueryEcsCount değerini True olarak ayarlarsanız yanıtta dönen parametre değeri geçerli olur. Not Bu parametre artık kullanılmamaktadır. Dönen miktar yalnızca referans amaçlıdır. Gerçek miktar dönen miktardan farklı olabilir.
AvailableInstanceAmount	Integer	0	Güvenlik grubuna eklenebilecek özel IP adreslerinin sayısı. Daha fazla bilgi için Temel güvenlik grupları ve gelişmiş güvenlik grupları bölümündeki "Güvenlik grubu kapasitesi" kısmına bakın. IsQueryEcsCount değerini True olarak ayarlarsanız yanıtta dönen parametre değeri geçerli olur. Not Bu parametre artık kullanılmamaktadır. Dönen miktar yalnızca referans amaçlıdır. Gerçek miktar dönen miktardan farklı olabilir.
ResourceGroupId	String	rg-bp67acfmxazb4p****	Güvenlik grubunun ait olduğu kaynak grubu kimliği.
ServiceManaged	Boolean	false	Güvenlik grubu kullanıcısının bir Alibaba Cloud hizmeti mi yoksa bir distribütör mü olduğunu gösterir.
ServiceID	Long	12345678910	Güvenlik grubunun ait olduğu distribütörün kimliği.
Tags	Array of Tag		Güvenlik grubunun etiketleri.
Tag
TagValue	String	TestValue	Etiketin değeri.
TagKey	String	TestKey	Etiketin anahtarı.
TotalCount	Integer	20	Toplam güvenlik grubu sayısı. İstekte `MaxResults` ve `NextToken` belirtilirse bu parametrenin değeri döndürülmez.
PageNumber	Integer	1	Sayfa numarası. Not Bu parametre gelecekte kaldırılacaktır. Sayfalı sorgu için NextToken ve MaxResults parametrelerini kullanmanızı öneririz.
PageSize	Integer	10	Sayfa başına girdi sayısı. Not Bu parametre gelecekte kaldırılacaktır. Sayfalı sorgu için NextToken ve MaxResults parametrelerini kullanmanızı öneririz.

Örnekler

Örnek istekler

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

Başarılı yanıt örnekleri

XML biçimi

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 biçimi

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"
}

Hata kodları

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 ve PageSize desteklenmiyor. Bunun yerine NextToken ve MaxResults kullanın.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	Geçersiz NextToken değeri.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	RegionId gereklidir.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	Geçersiz SecurityGroupType değeri.
500	InternalError	The request processing has failed due to some unknown error.	Dahili bir hata oluştu. Daha sonra tekrar deneyin.

Hata kodlarının listesi için bkz. Hizmet hata kodları.