All Products
Search

This Product

    Cloud Firewall:DescribeControlPolicy

    Document Center

    Cloud Firewall:DescribeControlPolicy

    Last Updated:Aug 02, 2026

    Mengambil informasi tentang semua kebijakan kontrol akses.

    Deskripsi operasi

    Operasi ini biasanya digunakan untuk kueri berhalaman informasi kebijakan kontrol akses.

    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

    yundun-cloudfirewall:DescribeControlPolicy

    get

    *ControlPolicyOrder.

    acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

    *ControlPolicy.

    acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    Jenis bahasa untuk menerima pesan. Nilai valid:

    zh
    Direction

    string

    No

    Arah trafik yang dikontrol oleh kebijakan kontrol akses. Nilai valid: in (arah masuk) atau out (arah keluar). Anda harus menentukan setidaknya satu dari Direction dan AclUuid. Jika AclUuid tidak ditentukan, Anda harus menentukan Direction yang tidak kosong. Jika tidak, error ErrorParametersDirection akan dikembalikan.

    Valid values:

    • in :

      Arah masuk, yang menunjukkan trafik dari sumber eksternal ke resource internal.

    • out :

      Arah keluar, yang menunjukkan trafik dari resource internal ke tujuan eksternal.

    in
    CurrentPage

    string

    Yes

    Nomor halaman dari halaman saat ini yang ditampilkan dalam kueri berhalaman.

    1
    PageSize

    string

    Yes

    Jumlah maksimum entri per halaman yang ditampilkan dalam kueri berhalaman.

    10
    Source

    string

    No

    Alamat sumber dalam kebijakan kontrol akses. Kueri fuzzy didukung. Nilainya bervariasi tergantung pada SourceType (jenis sumber).

    192.0.XX.XX
    Destination

    string

    No

    Alamat tujuan dalam kebijakan kontrol akses. Kueri fuzzy didukung. Nilainya bervariasi tergantung pada DestinationType (jenis tujuan).

    192.0.XX.XX
    Description

    string

    No

    Deskripsi kebijakan kontrol akses. Kueri fuzzy didukung.

    Izinkan akses ke segmen jaringan kantor
    Proto

    string

    No

    Jenis protokol trafik dalam kebijakan kontrol akses. Nilai valid:

    TCP
    AclAction

    string

    No

    Aksi yang dilakukan Cloud Firewall pada trafik dalam kebijakan kontrol akses. Nilai valid:

    accept
    Release

    string

    No

    Status aktif kebijakan kontrol akses. Nilai valid:

    true
    AclUuid

    string

    No

    ID unik kebijakan kontrol akses. Anda harus menentukan setidaknya satu dari AclUuid dan Direction. Jika AclUuid ditentukan, Anda dapat mengkueri kebijakan berdasarkan ID-nya.

    00281255-d220-4db1-8f4f-c4df221a****
    IpVersion

    string

    No

    Versi alamat IP yang didukung. Nilai valid:

    Valid values:

    • 4 :

      IPv4

    • 6 :

      IPv6

    6
    RepeatType

    string

    No

    Jenis pengulangan periode validitas kebijakan untuk kebijakan kontrol akses. Nilai valid:

    Valid values:

    • Daily :

      setiap hari.

    • Monthly :

      setiap bulan.

    • Permanent :

      selalu.

    • Weekly :

      setiap minggu.

    • None :

      periode satu kali tertentu.

    Permanent

    Elemen respons

    Element

    Type

    Description

    Example

    object

    PageNo

    string

    Nomor halaman dari halaman saat ini yang ditampilkan dalam kueri berhalaman.

    1
    PageSize

    string

    Jumlah maksimum entri per halaman yang ditampilkan dalam kueri berhalaman.

    10
    RequestId

    string

    ID permintaan.

    CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
    TotalCount

    string

    Jumlah total kebijakan kontrol akses.

    100
    Policys

    array<object>

    Informasi tentang kebijakan kontrol akses.

    object

    Detail kebijakan kontrol akses.

    Direction

    string

    Arah trafik kebijakan kontrol akses. Nilai valid:

    in
    Order

    integer

    Prioritas kebijakan kontrol akses.

    1
    SourceType

    string

    Jenis alamat sumber dalam kebijakan kontrol akses. Nilai valid:

    net
    ApplicationName

    string

    Jenis aplikasi yang didukung oleh kebijakan kontrol akses. Kami menyarankan Anda menggunakan ApplicationNameList. Nilai valid:

    HTTP
    HitTimes

    integer

    Jumlah hit untuk kebijakan kontrol akses.

    100
    Description

    string

    Deskripsi kebijakan kontrol akses.

    Izinkan akses ke segmen jaringan kantor
    SourceGroupType

    string

    Jenis buku alamat sumber dalam kebijakan kontrol akses. Nilai valid:

    ip
    DnsResultTime

    integer

    Stempel waktu resolusi DNS. Nilainya adalah Stempel waktu UNIX dalam detik.

    1579261141
    DnsResult deprecated

    string

    Hasil resolusi DNS.

    192.0.XX.XX,192.0.XX.XX
    Proto

    string

    Jenis protokol keamanan trafik dalam kebijakan kontrol akses. Nilai valid:

    TCP
    DestinationGroupType

    string

    Jenis buku alamat tujuan dalam kebijakan kontrol akses. Nilai valid:

    ip
    Destination

    string

    Alamat tujuan dalam kebijakan kontrol akses. Nilainya bervariasi tergantung pada DestinationType (jenis tujuan). Nilai valid:

    192.0.XX.XX/24
    HitLastTime

    integer

    Waktu hit paling baru. Nilainya dalam format Stempel waktu UNIX dalam detik.

    1579261141
    DestPortGroup

    string

    Nama buku alamat port tujuan dalam kebijakan kontrol akses.

    my_port_group
    AclUuid

    string

    ID unik kebijakan kontrol akses.

    00281255-d220-4db1-8f4f-c4df221a****
    DestPortType

    string

    Jenis port tujuan dalam kebijakan kontrol akses. Nilai valid:

    port
    Source

    string

    Alamat sumber dalam kebijakan kontrol akses. Nilai valid:

    192.0.XX.XX/24
    DestinationType

    string

    Jenis alamat tujuan dalam kebijakan kontrol akses. Nilai valid:

    net
    DestPort

    string

    Port tujuan trafik dalam kebijakan kontrol akses.

    80
    IpVersion

    integer

    Versi alamat IP yang didukung. Nilai valid:

    6
    AclAction

    string

    Aksi yang dilakukan Cloud Firewall pada trafik dalam kebijakan kontrol akses. Nilai valid:

    accept
    Release

    string

    Status aktif kebijakan kontrol akses. Kebijakan diaktifkan secara default setelah dibuat. Nilai valid:

    true
    ApplicationId

    string

    ID aplikasi trafik dalam kebijakan kontrol akses.

    10***
    DestinationGroupCidrs

    array

    Daftar blok CIDR dalam buku alamat tujuan kebijakan kontrol akses.

    string

    Blok CIDR dalam buku alamat tujuan kebijakan kontrol akses.

    192.0.XX.XX/24
    DestPortGroupPorts

    array

    Daftar port dalam buku alamat port tujuan.

    string

    Port dalam buku alamat port tujuan.

    80/80
    SourceGroupCidrs

    array

    Daftar blok CIDR dalam buku alamat sumber kebijakan kontrol akses.

    string

    Blok CIDR dalam buku alamat sumber kebijakan kontrol akses.

    192.0.XX.XX/24
    ApplicationNameList

    array

    Daftar nama aplikasi.

    string

    Daftar jenis aplikasi yang didukung oleh kebijakan kontrol akses. Nilai valid:

    HTTP
    SpreadCnt

    integer

    Jumlah unit kuota yang dikonsumsi oleh kebijakan kontrol akses, yaitu jumlah kumulatif unit kuota yang dikonsumsi oleh setiap kebijakan.

    10000
    CreateTime

    integer

    Waktu pembuatan kebijakan. Nilainya adalah Stempel waktu UNIX dalam detik, yaitu jumlah detik yang telah berlalu sejak 1 Januari 1970 (UTC).

    1761062400
    ModifyTime

    integer

    Waktu terakhir modifikasi kebijakan. Nilainya adalah Stempel waktu UNIX dalam detik, yaitu jumlah detik yang telah berlalu sejak 1 Januari 1970 (UTC).

    1761062400
    RepeatType

    string

    Jenis pengulangan periode validitas kebijakan untuk kebijakan kontrol akses. Nilai valid:

    Valid values:

    • Daily :

      setiap hari.

    • Monthly :

      setiap bulan.

    • Permanent :

      selalu.

    • Weekly :

      setiap minggu.

    • None :

      periode satu kali tertentu.

    Permanent
    RepeatDays

    array

    Kumpulan hari pengulangan untuk periode validitas kebijakan kontrol akses.

    integer

    Hari pengulangan untuk periode validitas kebijakan kontrol akses.

    1
    RepeatStartTime

    string

    Waktu mulai pengulangan periode validitas kebijakan untuk kebijakan kontrol akses. Contoh: 08:00. Nilainya harus pada jam penuh atau setengah jam dan harus setidaknya 30 menit lebih awal dari waktu akhir pengulangan.

    08:00
    RepeatEndTime

    string

    Waktu akhir pengulangan periode validitas kebijakan untuk kebijakan kontrol akses. Contoh: 23:30. Nilainya harus pada jam penuh atau setengah jam dan harus setidaknya 30 menit lebih lambat dari waktu mulai pengulangan.

    23:30
    StartTime

    integer

    Waktu mulai periode validitas kebijakan untuk kebijakan kontrol akses. Nilainya adalah Stempel waktu UNIX dalam detik. Nilainya harus pada jam penuh atau setengah jam dan harus setidaknya 30 menit lebih awal dari waktu akhir.

    1694761200
    EndTime

    integer

    Waktu akhir periode validitas kebijakan untuk kebijakan kontrol akses. Nilainya adalah Stempel waktu UNIX dalam detik. Nilainya harus pada jam penuh atau setengah jam dan harus setidaknya 30 menit lebih lambat dari waktu mulai.

    1694764800
    DomainResolveType

    string

    Metode resolusi nama domain kebijakan kontrol akses. Nilai valid:

    FQDN

    Contoh

    Respons sukses

    JSONformat

    {
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net.",
      "ApplicationName": "HTTP.",
      "HitTimes": 100,
      "Description": "test.",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP.",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group.",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port.",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net.",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept.",
      "Release": "true.",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP."
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent.",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN."
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorParametersUid The aliUid parameter is invalid.
    400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid.
    400 ErrorParameterIpVersion The IP version is invalid.
    400 ErrorParametersDirection The direction is invalid.
    400 ErrorDBSelect An error occurred while querying database.
    400 ErrorUnmarshalJSON An error occurred while parsing JSON.
    400 ErrorUUIDNew The UUID is invalid.
    400 ErrorParametersAppId The AppId parameter is incorrect.
    400 ErrorParametersSource The source is invalid.
    400 ErrorDomainResolve An error occurred while resolving the domain.
    400 ErrorParametersDestination The Destination parameter is invalid.
    400 ErrorParametersProto The protocol is invalid.
    400 ErrorParametersDestPort The dst_port is invalid.
    400 ErrorParametersAction The action is invalid.
    400 ErrorParameters Parameters error.
    400 ErrorMarshalJSON An error occurred while encoding JSON.
    400 ErrorParametersAclUuid Specified parameter AclUuid is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.