DescribeSecurityGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri informasi dasar tentang grup keamanan. Anda dapat memfilter hasil berdasarkan wilayah, ID grup keamanan, tipe grup keamanan, dan parameter lainnya.

Deskripsi operasi

Kueri pagination: Gunakan MaxResults dan NextToken untuk kueri pagination.
- Jika NextToken tidak dikembalikan, halaman saat ini adalah halaman terakhir.
- Untuk halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan digunakan untuk mengkueri halaman berikutnya.
- Untuk halaman berikutnya, tetapkan NextToken ke nilai NextToken yang dikembalikan dalam tanggapan sebelumnya dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan.
Saat Anda memanggil operasi API menggunakan Asisten Cloud CLI, tentukan parameter permintaan dalam format yang diperlukan. Untuk informasi lebih lanjut, lihat Format parameter perintah CLI.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeSecurityGroups

get

SecurityGroup

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

SecurityGroup

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

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
SecurityGroupIds	string	No	ID grup keamanan. Anda dapat menentukan hingga 100 ID grup keamanan. Pisahkan beberapa ID dengan koma (,) dalam format array JSON.	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]
VpcId	string	No	ID virtual private cloud (VPC) tempat grup keamanan berada.	vpc-bp67acfmxazb4p****
SecurityGroupType	string	No	Tipe grup keamanan. Nilai valid: normal: grup keamanan dasar. enterprise: grup keamanan lanjutan. Catatan Jika Anda tidak menentukan parameter ini, grup keamanan dari semua tipe akan dikueri.	normal
NextToken	string	No	Token pagination. Tetapkan parameter ini ke nilai NextToken yang dikembalikan dalam permintaan sebelumnya. Anda tidak perlu menetapkan parameter ini untuk permintaan pertama.	e71d8a535bd9cc11
MaxResults	integer	No	Jumlah entri maksimum per halaman untuk kueri pagination. Jika Anda menetapkan parameter ini, metode pagination `MaxResults` dan `NextToken` akan digunakan. Nilai maksimum: 100. Nilai default: 10.	10
NetworkType	string	No	Jenis jaringan grup keamanan. Nilai valid: vpc: VPC. classic: jaringan klasik. Jaringan klasik tidak digunakan lagi. Untuk informasi lebih lanjut, lihat Pemberitahuan penghentian.	vpc
SecurityGroupName	string	No	Nama grup keamanan.	SGTestName
IsQueryEcsCount	boolean	No	Apakah akan mengkueri informasi kapasitas grup keamanan. Jika Anda menetapkan parameter ini ke True, nilai `EcsCount` dan `AvailableInstanceAmount` dalam tanggapan akan valid. Catatan Parameter ini tidak digunakan lagi.	null
ResourceGroupId	string	No	ID kelompok sumber daya tempat grup keamanan berada. Saat Anda menggunakan parameter ini untuk memfilter sumber daya, jumlah sumber daya tidak boleh melebihi 1.000. Anda dapat memanggil ListResourceGroups untuk mengkueri kelompok sumber daya. Catatan Pemfilteran berdasarkan kelompok sumber daya default tidak didukung.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Tag.
	object	No	Tag.
key	string	No	Kunci tag grup keamanan. Catatan Untuk kompatibilitas yang lebih baik, gunakan parameter Tag.N.Key.	testkey
Key	string	No	Kunci tag grup keamanan. Nilai valid N: 1 hingga 20. Jika Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya dengan tag yang ditentukan tidak boleh melebihi 1.000. Jika Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang memiliki semua tag yang ditentukan terpasang tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil ListTagResources untuk mengkueri sumber daya.	TestKey
Value	string	No	Nilai tag grup keamanan. Nilai valid N: 1 hingga 20.	TestValue
value	string	No	Nilai tag grup keamanan. Catatan Untuk kompatibilitas yang lebih baik, gunakan parameter Tag.N.Value.	testvalue
DryRun	boolean	No	Apakah akan menjalankan dry run saja. Nilai valid: true: Hanya menjalankan dry run. Sistem memeriksa permintaan untuk potensi masalah, termasuk pasangan AccessKey yang tidak valid, pengguna Resource Access Management (RAM) yang tidak diotorisasi, dan nilai parameter yang hilang. Jika permintaan gagal dalam dry run, pesan kesalahan dikembalikan. Jika permintaan lulus dry run, kode kesalahan DryRunOperation dikembalikan. false: Menjalankan dry run dan mengirimkan permintaan Normal. Jika permintaan lulus dry run, kode status HTTP 2xx dikembalikan dan otorisasi diverifikasi. Nilai default: false.	false
SecurityGroupId	string	No	ID grup keamanan.	sg-bp67acfmxazb4p****
FuzzyQuery	boolean	No	Catatan Parameter ini tidak digunakan lagi.	null
PageNumber	integer	No	Catatan Parameter ini akan dihentikan. Gunakan NextToken dan MaxResults untuk pagination.	1
PageSize	integer	No	Catatan Parameter ini akan dihentikan. Gunakan NextToken dan MaxResults untuk pagination.	10
ServiceManaged	boolean	No	Apakah grup keamanan dikelola. Nilai valid: true: Grup keamanan dikelola. false: Grup keamanan tidak dikelola.	false

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionId	string	ID wilayah grup keamanan.	cn-hangzhou
NextToken	string	Token pagination yang dikembalikan dalam panggilan ini. Jika nilai ini kosong saat Anda menggunakan MaxResults dan NextToken untuk pagination, tidak ada data lagi yang tersedia.	e71d8a535bd9cc11
SecurityGroups	object
SecurityGroup	array<object>	Kumpulan informasi grup keamanan.
	array<object>	Informasi grup keamanan.
SecurityGroupId	string	ID grup keamanan.	sg-bp67acfmxazb4p****
SecurityGroupName	string	Nama grup keamanan.	SGTestName
Description	string	Deskripsi grup keamanan.	TestDescription
SecurityGroupType	string	Tipe grup keamanan. Nilai valid: normal: grup keamanan dasar. enterprise: grup keamanan lanjutan.	normal
VpcId	string	VPC tempat grup keamanan berada.	vpc-bp67acfmxazb4p****
CreationTime	string	Pengatur waktu pembuatan grup keamanan. Pengatur waktu mengikuti standar ISO 8601 dalam UTC. Format: yyyy-MM-ddThh:mmZ.	2021-08-31T03:12:29Z
EcsCount	integer	Jumlah alamat IP privat yang ditampung dalam grup keamanan. Untuk informasi lebih lanjut, lihat Kapasitas grup keamanan. Parameter ini hanya valid ketika parameter permintaan IsQueryEcsCount disetel ke True. Catatan Parameter ini tidak digunakan lagi. Jumlah dalam tanggapan hanya untuk referensi dan tidak konsisten secara real time.	0
AvailableInstanceAmount	integer	Jumlah alamat IP privat yang masih dapat ditambahkan ke grup keamanan. Untuk informasi lebih lanjut, lihat Kapasitas grup keamanan. Parameter ini hanya valid ketika parameter permintaan IsQueryEcsCount disetel ke True. Catatan Parameter ini tidak digunakan lagi. Jumlah dalam tanggapan hanya untuk referensi dan tidak konsisten secara real time.	0
ResourceGroupId	string	ID kelompok sumber daya tempat grup keamanan berada.	rg-bp67acfmxazb4p****
ServiceManaged	boolean	Menunjukkan apakah grup keamanan digunakan oleh layanan cloud atau distributor.	false
ServiceID	integer	ID distributor yang terkait dengan grup keamanan.	12345678910
Tags	object
Tag	array<object>	Kumpulan tag untuk grup keamanan.
	object	Tag grup keamanan.
TagValue	string	Nilai tag grup keamanan.	TestValue
TagKey	string	Kunci tag grup keamanan.	TestKey
RuleCount	integer	Jumlah aturan dalam grup keamanan.	100
GroupToGroupRuleCount	integer	Jumlah aturan yang mengizinkan akses dari grup keamanan lain.	5
TotalCount	integer	Jumlah total grup keamanan. Parameter ini tidak dikembalikan saat Anda menggunakan `MaxResults` dan `NextToken` untuk kueri parameter.	20
PageNumber	integer	Nomor halaman saat ini. Catatan Parameter ini akan dihentikan. Gunakan NextToken dan MaxResults untuk pagination.	1
PageSize	integer	Jumlah entri per halaman. Catatan Parameter ini akan dihentikan. Gunakan NextToken dan MaxResults untuk pagination.	10

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.
400	InValidParameter.NextToken	The parameter NextToken is invalid.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.
500	InternalError	The request processing has failed due to some unknown error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.