DescribeSecurityGroups - - Alibaba Cloud Documentation Center

Mengambil informasi dasar security group yang telah Anda buat, seperti ID, deskripsi, tipe, dan jenis jaringannya.

Catatan penggunaan

Perhatikan hal-hal berikut:

Informasi dasar security group mencakup ID dan deskripsinya. Respons mengembalikan security group dalam urutan menurun berdasarkan ID-nya.
Kami menyarankan Anda menggunakan parameter MaxResults dan NextToken untuk kueri berhalaman. Gunakan MaxResults untuk menentukan jumlah maksimum entri yang dikembalikan dalam setiap permintaan. Nilai kembali dari NextToken adalah token pagination yang dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Saat melakukan permintaan berikutnya, atur NextToken ke nilai NextToken yang dikembalikan dalam panggilan sebelumnya dan gunakan MaxResults untuk menentukan jumlah maksimum entri yang dikembalikan dalam permintaan tersebut. Jika nilai kembali dari NextToken kosong, halaman hasil saat ini merupakan halaman terakhir dan tidak ada lagi hasil yang akan dikembalikan.
Saat menggunakan Alibaba Cloud CLI untuk memanggil operasi API, Anda harus menentukan nilai parameter permintaan dengan tipe data berbeda dalam format yang diperlukan. Untuk informasi selengkapnya, lihat Ikhtisar format parameter.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeSecurityGroups	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeSecurityGroups.
RegionId	String	Ya	cn-hangzhou	ID wilayah security group. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.
SecurityGroupIds	String	Tidak	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]	ID security group. Nilainya berupa array JSON yang terdiri dari maksimal 100 ID security group. Pisahkan ID security group dengan koma (,).
VpcId	String	Tidak	vpc-bp67acfmxazb4p****	ID Virtual Private Cloud (VPC) tempat security group tersebut berada.
SecurityGroupType	String	Tidak	normal	Tipe security group. Nilai yang valid: normal: basic security group enterprise: advanced security group Catatan Jika Anda tidak menentukan parameter ini, baik basic maupun advanced security group akan dikueri.
NextToken	String	Tidak	e71d8a535bd9cc11	Token pagination yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Anda tidak perlu menentukan parameter ini untuk permintaan pertama. Anda harus menetapkan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.
MaxResults	Integer	Tidak	10	Jumlah maksimum entri per halaman. Jika Anda menentukan MaxResults, `MaxResults` dan `NextToken` digunakan untuk kueri berhalaman. Nilai yang valid: 1 hingga 100. Nilai default: 10.
NetworkType	String	Tidak	vpc	Jenis jaringan security group. Nilai yang valid: vpc classic
SecurityGroupName	String	Tidak	SGTestName	Nama security group.
IsQueryEcsCount	Boolean	Tidak	null	Menentukan apakah akan mengkueri kapasitas security group. Jika Anda menetapkan parameter ini ke True, nilai `EcsCount` dan `AvailableInstanceAmount` dalam respons akan valid. Catatan Parameter ini tidak lagi digunakan.
ResourceGroupId	String	Tidak	rg-bp67acfmxazb4p****	ID kelompok sumber daya tempat security group tersebut berada. Jika parameter ini ditentukan untuk mengkueri sumber daya, maksimal 1.000 sumber daya yang termasuk dalam kelompok sumber daya yang ditentukan akan ditampilkan dalam respons. Anda dapat memanggil operasi ListResourceGroups untuk mengkueri daftar kelompok sumber daya terbaru. Catatan Sumber daya dalam kelompok sumber daya default akan ditampilkan dalam respons terlepas dari bagaimana parameter ini diatur.
Tag.N.key	String	Tidak	testkey	Kunci tag N dari security group. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan Anda menggunakan parameter Tag.N.Key untuk memastikan kompatibilitas di masa depan.
Tag.N.Key	String	Tidak	TestKey	Kunci tag N dari security group. Nilai N yang valid: 1 hingga 20. Jika satu tag ditentukan untuk mengkueri sumber daya, maksimal 1.000 sumber daya yang memiliki tag tersebut akan dikembalikan. Jika beberapa tag ditentukan untuk mengkueri sumber daya, maksimal 1.000 sumber daya yang memiliki semua tag tersebut akan dikembalikan. Untuk mengkueri lebih dari 1.000 sumber daya yang memiliki tag yang ditentukan, panggil operasi ListTagResources.
Tag.N.Value	String	Tidak	TestValue	Nilai tag tersebut. Nilai N yang valid: 1 hingga 20.
Tag.N.value	String	Tidak	testvalue	Nilai tag N dari security group. Catatan Parameter ini akan ditinggalkan di masa mendatang. Kami menyarankan Anda menggunakan parameter Tag.N.Value untuk memastikan kompatibilitas di masa depan.
DryRun	Boolean	Tidak	false	Menentukan apakah hanya menjalankan dry run tanpa melakukan permintaan aktual. Nilai yang valid: true: hanya menjalankan dry run. Sistem memeriksa Pasangan Kunci Akses, izin Pengguna Resource Access Management (RAM), dan parameter yang diperlukan. Jika permintaan gagal dalam dry run, pesan kesalahan akan dikembalikan. Jika tidak, kode kesalahan DryRunOperation akan dikembalikan. false: menjalankan dry run dan melakukan permintaan aktual. Jika permintaan lolos dry run, kode status HTTP 2xx akan dikembalikan dan operasi akan dilakukan. Nilai default: false.
SecurityGroupId	String	Tidak	sg-bp67acfmxazb4p****	ID security group.
FuzzyQuery	Boolean	Tidak	null	Catatan Parameter ini tidak lagi digunakan.
PageNumber	Integer	Tidak	1	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan Anda menggunakan parameter NextToken dan MaxResults untuk kueri berhalaman.
PageSize	Integer	Tidak	10	Jumlah entri per halaman. Nilai yang valid: 1 hingga 50. Nilai default: 10. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan Anda menggunakan parameter NextToken dan MaxResults untuk kueri berhalaman.
ServiceManaged	Boolean	Tidak	false	Menentukan apakah akan mengkueri security group terkelola. Nilai yang valid: true false

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID permintaan.
RegionId	String	cn-hangzhou	ID wilayah security group.
NextToken	String	e71d8a535bd9cc11	Token pagination. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika nilai kembali parameter ini kosong saat Anda menentukan MaxResults dan NextToken untuk kueri berhalaman, tidak ada lagi hasil yang akan dikembalikan.
SecurityGroups	Array of SecurityGroup		Detail mengenai security group.
SecurityGroup
SecurityGroupId	String	sg-bp67acfmxazb4p****	ID security group.
SecurityGroupName	String	SGTestName	Nama security group.
Description	String	TestDescription	Deskripsi security group.
SecurityGroupType	String	normal	Tipe security group. Nilai yang valid: normal: basic security group enterprise: advanced security group
VpcId	String	vpc-bp67acfmxazb4p****	ID VPC tempat security group tersebut berada.
CreationTime	String	2021-08-31T03:12:29Z	Waktu pembuatan security group. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddThh:mmZ. Waktu ditampilkan dalam UTC.
EcsCount	Integer	0	Jumlah Alamat IP pribadi yang terdapat dalam security group. Untuk informasi selengkapnya, lihat bagian "Kapasitas security group" dalam Basic security groups and advanced security groups. Jika Anda menetapkan IsQueryEcsCount ke True, nilai parameter dalam respons akan valid. Catatan Parameter ini tidak lagi digunakan. Jumlah yang dikembalikan hanya sebagai referensi. Jumlah aktual mungkin berbeda dari jumlah yang dikembalikan.
AvailableInstanceAmount	Integer	0	Jumlah Alamat IP pribadi yang dapat ditambahkan ke security group. Untuk informasi selengkapnya, lihat bagian "Kapasitas security group" dalam Basic security groups and advanced security groups. Jika Anda menetapkan IsQueryEcsCount ke True, nilai parameter dalam respons akan valid. Catatan Parameter ini tidak lagi digunakan. Jumlah yang dikembalikan hanya sebagai referensi. Jumlah aktual mungkin berbeda dari jumlah yang dikembalikan.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID kelompok sumber daya tempat security group tersebut berada.
ServiceManaged	Boolean	false	Menunjukkan apakah pengguna security group merupakan Layanan Alibaba Cloud atau distributor.
ServiceID	Long	12345678910	ID distributor tempat security group tersebut berada.
Tags	Array of Tag		Tag security group.
Tag
TagValue	String	TestValue	Nilai tag.
TagKey	String	TestKey	Kunci tag.
TotalCount	Integer	20	Jumlah total security group. Jika `MaxResults` dan `NextToken` ditentukan dalam permintaan, nilai parameter ini tidak dikembalikan.
PageNumber	Integer	1	Nomor halaman. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan Anda menggunakan parameter NextToken dan MaxResults untuk kueri berhalaman.
PageSize	Integer	10	Jumlah entri per halaman. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan Anda menggunakan parameter NextToken dan MaxResults untuk kueri berhalaman.

Contoh

Permintaan contoh

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

Respons sukses contoh

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

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	PageNumber dan PageSize tidak didukung. Gunakan NextToken dan MaxResults sebagai gantinya.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	Nilai NextToken tidak valid.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	RegionId wajib diisi.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	Nilai SecurityGroupType tidak valid.
500	InternalError	The request processing has failed due to some unknown error.	Terjadi kesalahan internal. Coba lagi nanti.

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.