DescribeFlowlogs - Cloud Enterprise Network

Mengambil informasi flow log.

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

cen:DescribeFlowlogs

get

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/*

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/{#FlowLogId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan nilai ini, tetapi Anda harus memastikan nilainya unik di antara semua permintaan. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menyetel parameter ini, ClientToken akan diatur ke nilai RequestId. Nilai RequestId untuk setiap permintaan API mungkin berbeda.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	No	ID wilayah tempat flow log ditempatkan. Anda dapat memanggil operasi DescribeChildInstanceRegions untuk menanyakan daftar wilayah terbaru.	cn-hangzhou
FlowLogName	string	No	Nama flow log. Nama bersifat opsional. Jika Anda memasukkan nama, panjangnya harus 1 hingga 128 karakter, dan tidak boleh dimulai dengan http:// atau https://.	myFlowlog
FlowLogId	string	No	ID flow log.	flowlog-m5evbtbpt****
Description	string	No	Deskripsi flow log. Deskripsi bersifat opsional. Jika Anda memasukkan deskripsi, panjangnya harus 1 hingga 256 karakter, dan tidak boleh dimulai dengan http:// atau https://.	myFlowlog
CenId	string	No	ID instans Cloud Enterprise Network (CEN).	cen-7qthudw0ll6jmc****
ProjectName	string	No	Nama proyek tempat flow log disimpan. Panjang nama harus 3 hingga 63 karakter, dan hanya boleh berisi huruf kecil, angka, serta tanda hubung (-). Nama harus dimulai atau diakhiri dengan huruf kecil atau angka.	FlowLogProject
LogStoreName	string	No	Nama Logstore tempat flow log disimpan. Panjang nama harus 3 hingga 63 karakter, dan hanya boleh berisi huruf kecil, angka, garis bawah (_), serta tanda hubung (-). Nama harus dimulai atau diakhiri dengan huruf kecil atau angka.	FlowLogStore
Status	string	No	Status flow log. Nilai yang valid: Active: Flow log diaktifkan. Inactive: Flow log dinonaktifkan.	Active
PageNumber	integer	No	Nomor halaman yang dikembalikan. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai minimum: 1. Nilai default: 20.	20
Tag	array<object>	No	Informasi tentang tag. Anda dapat menentukan maksimal 20 tag dalam setiap panggilan.
	object	No
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 64 karakter dan tidak boleh dimulai dengan `acs:` atau `aliyun`. Kunci tag juga tidak boleh mengandung `http://` atau `https://`. Anda dapat menentukan maksimal 20 kunci tag.	TagKey
Value	string	No	Nilai tag. Panjang nilai tag boleh 0 hingga 128 karakter, dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Nilai tag juga tidak boleh mengandung `http://` atau `https://`. Setiap kunci tag harus memiliki nilai tag yang unik. Anda dapat menentukan maksimal 20 nilai tag dalam setiap panggilan.	TagValue
TransitRouterAttachmentId	string	No	ID koneksi instans jaringan.	tr-attach-qieks13jnt1cchy****
TransitRouterId	string	No	ID router transit.	tr-uf654ttymmljlvh2x****
Interval	integer	No	Jendela waktu untuk mengumpulkan data log. Satuan: detik. Nilai yang valid: 60 atau 600. Nilai default: 600.	600
FlowLogVersion	string	No	Versi flow log. Flow log dibuat secara otomatis dalam versi terbaru, yaitu 3.	3

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
PageSize	string	Jumlah entri yang dikembalikan per halaman.	20
PageNumber	string	Nomor halaman yang dikembalikan.	1
RequestId	string	ID permintaan.	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	Total jumlah entri yang dikembalikan.	1
Success	string	Menunjukkan apakah pemanggilan berhasil. Nilai yang valid: true: ya false: tidak	true
FlowLogs	object
FlowLog	array<object>	Informasi tentang flow log.
	array<object>	Informasi tentang flow log.
Status	string	Status flow log. Nilai yang valid: Active: Flow log diaktifkan. Inactive: Flow log dinonaktifkan.	Active
CreationTime	string	Waktu saat flow log dibuat. Waktu mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ssZ. Waktu ditampilkan dalam UTC.	2021-07-24T13:00:52Z
FlowLogName	string	Nama flow log.	myFlowlog
Description	string	Deskripsi flow log.	myFlowlog
ProjectName	string	Nama proyek yang menyimpan data traffic yang ditangkap.	FlowLogProject
CenId	string	ID instans Cloud Enterprise Network (CEN).	cen-7qthudw0ll6jmc****
LogStoreName	string	Logstore yang menyimpan data traffic yang ditangkap.	FlowLogStore
RegionId	string	ID wilayah flow log.	cn-hangzhou
FlowLogId	string	ID flow log.	flowlog-m5evbtbpt****
TransitRouterAttachmentId	string	ID koneksi instans jaringan	tr-attach-5x4o4ynzuqbv6g****
TransitRouterId	string	ID router transit.	tr-bp1g9313sx675zr1lajmj
LogFormatString	string	String yang menentukan format flow log. Format: `${Field 1}${Field 2}${Field 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	Versi flow log. Flow log dibuat secara otomatis dalam versi terbaru, yaitu 3.	3
Interval	integer	Jendela waktu untuk mengumpulkan data log. Satuan: detik. Nilai yang valid: 60 atau 600. Nilai default: 600.	60
Tags	object
Tag	array<object>	Tag.
	object	Tag N yang ditambahkan ke instans.
Key	string	Kunci tag.	TagKey
Value	string	Nilai tag.	TagValue

Contoh

Respons sukses

JSONformat

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2021-07-24T13:00:52Z",
        "FlowLogName": "myFlowlog",
        "Description": "myFlowlog",
        "ProjectName": "FlowLogProject",
        "CenId": "cen-7qthudw0ll6jmc****",
        "LogStoreName": "FlowLogStore",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "flowlog-m5evbtbpt****",
        "TransitRouterAttachmentId": "tr-attach-5x4o4ynzuqbv6g****",
        "TransitRouterId": "tr-bp1g9313sx675zr1lajmj",
        "LogFormatString": "${srcaddr}${dstaddr}${bytes}",
        "FlowLogVersion": "3",
        "Interval": 60,
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	OperationUnsupported.action	This action is not support.	The error message returned because this operation is not supported in the specified region.
400	InvalidFlowlogId.NotFound	The specified flowlog id does not exist or does not match the cen Id.	The error message returned because the specified flow log does not exist.
400	IllegalParam.TagValue	The tag values are not valid.	The error message returned because the specified tag value is invalid.
400	IllegalParam.TagKey	The tag keys are not valid.	The error message returned because the specified tag key is invalid.
400	InvalidDescription	Description is invalid.	The error message returned because the description is invalid.
400	InvalidName	Name is invalid.	The error message returned because the specified name is invalid.
400	InvalidParameter.Interval	Interval is invalid.	The specified interval is invalid.
400	InvalidParameter.FlowLogVersion	Flowlog version is invalid.	The specified flowlog version is invalid.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.