全部产品
Search

搜索本产品

    Cloud Firewall：DescribeControlPolicy

    文档中心

    Cloud Firewall：DescribeControlPolicy

    更新时间：Dec 18, 2025

    Mengambil informasi mengenai semua kebijakan kontrol akses.

    Deskripsi operasi

    Operasi ini mengambil kebijakan kontrol akses secara terpaginasi.

    Batas QPS

    Batas permintaan per detik (QPS) untuk satu pengguna adalah 10. Jika batas ini terlampaui, panggilan API akan dikenai Pengendalian aliran, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan API Anda dengan cermat.

    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

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    Bahasa pesan respons. Nilai yang valid:

    • zh (default): Bahasa Tiongkok

    • en: Bahasa Inggris

    zh
    Lang

    string

    No

    Bahasa pesan respons. Nilai yang valid:

    • zh (default): Bahasa Tiongkok

    • en: Bahasa Inggris

    zh
    Direction

    string

    No

    Arah traffic dari kebijakan kontrol akses. Nilai yang valid:

    • in: lalu lintas masuk

    • out: lalu lintas keluar

    in
    CurrentPage

    string

    Yes

    Nomor halaman.

    Nilai default: 1.

    1
    PageSize

    string

    Yes

    Jumlah entri per halaman.

    10
    Source

    string

    No

    Alamat sumber dalam kebijakan kontrol akses. Pencocokan fuzzy didukung. Nilai parameter ini bergantung pada nilai parameter SourceType.

    • Jika SourceType diatur ke net, nilai parameter ini adalah Blok CIDR. Contoh: 192.0.XX.XX/24.

    • Jika SourceType diatur ke group, nilai parameter ini adalah nama Buku alamat sumber. Contoh: db_group.

    • Jika SourceType diatur ke location, nilai parameter ini adalah lokasi sumber. Contoh: Beijing.

    Catatan

    Jika Anda tidak menentukan parameter ini, kebijakan tidak difilter berdasarkan alamat sumber.

    192.0.XX.XX
    Destination

    string

    No

    Alamat tujuan dalam kebijakan kontrol akses. Pencocokan fuzzy didukung. Nilai parameter ini bergantung pada nilai parameter DestinationType.

    • Jika DestinationType diatur ke net, nilai parameter ini adalah Blok CIDR. Contoh: 10.0.3.0/24.

    • Jika DestinationType diatur ke domain, nilai parameter ini adalah Nama domain. Contoh: aliyun.

    • Jika DestinationType diatur ke group, nilai parameter ini adalah nama Buku alamat. Contoh: db_group.

    • Jika DestinationType diatur ke location, nilai parameter ini adalah lokasi. Contoh: ["BJ11", "ZB"]. Untuk informasi selengkapnya tentang kode lokasi, lihat AddControlPolicy.

    Catatan

    Jika Anda tidak menentukan parameter ini, kebijakan tidak difilter berdasarkan alamat tujuan.

    192.0.XX.XX
    Description

    string

    No

    Deskripsi kebijakan kontrol akses. Pencocokan fuzzy didukung.

    Catatan

    Jika Anda tidak menentukan parameter ini, kebijakan tidak difilter berdasarkan deskripsi.

    test
    Proto

    string

    No

    Protokol. Nilai yang valid:

    • TCP

    • UDP

    • ICMP

    • ANY (semua protokol)

    Catatan

    Jika Anda tidak menentukan parameter ini, kebijakan tidak difilter berdasarkan protokol.

    TCP
    AclAction

    string

    No

    Aksi yang dilakukan Cloud Firewall terhadap traffic yang sesuai dengan kebijakan. Nilai yang valid:

    • accept: mengizinkan traffic.

    • drop: menolak traffic.

    • log: memantau traffic.

    Catatan

    Jika Anda tidak menentukan parameter ini, kebijakan tidak difilter berdasarkan aksi.

    accept
    Release

    string

    No

    Status kebijakan kontrol akses. Nilai yang valid:

    • true: diaktifkan

    • false: dinonaktifkan

    true
    AclUuid

    string

    No

    ID unik kebijakan kontrol akses.

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

    string

    No

    Versi IP. Nilai yang valid:

    • 4 (default): IPv4

    • 6: IPv6

    6
    RepeatType

    string

    No

    Jenis pengulangan untuk kebijakan. Nilai yang valid:

    • Permanent (default): Kebijakan selalu berlaku.

    • None: Kebijakan berlaku untuk periode tertentu.

    • Daily: Kebijakan berlaku setiap hari.

    • Weekly: Kebijakan berlaku setiap minggu.

    • Monthly: Kebijakan berlaku setiap bulan.

    Valid values:

    • Daily :

      Daily

    • Monthly :

      Monthly

    • Permanent :

      Kebijakan selalu berlaku.

    • Weekly :

      Weekly

    • None :

      Kebijakan berlaku untuk periode tertentu.

    Permanent

    Elemen respons

    Element

    Type

    Description

    Example

    object

    PageNo

    string

    Nomor halaman.

    1
    PageSize

    string

    Jumlah entri per halaman.

    10
    RequestId

    string

    ID permintaan.

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

    string

    Total jumlah kebijakan yang sesuai dengan kueri.

    100
    Policys

    array<object>

    Kebijakan kontrol akses.

    object

    Tidak tersedia deskripsi.

    Direction

    string

    Arah traffic. Nilai yang valid:

    • in: inbound

    • out: outbound

    in
    Order

    integer

    Prioritas kebijakan kontrol akses.

    Nilai prioritas dimulai dari 1. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi.

    1
    SourceType

    string

    Jenis alamat sumber. Nilai yang valid:

    • net: Blok CIDR

    • group: Buku alamat

    • location: lokasi

    net
    ApplicationName

    string

    Jenis aplikasi yang didukung oleh kebijakan kontrol akses. Kami menyarankan agar Anda menggunakan parameter `ApplicationNameList` sebagai gantinya. Nilai yang valid:

    • FTP

    • HTTP

    • HTTPS

    • Memcache

    • MongoDB

    • MQTT

    • MySQL

    • RDP

    • Redis

    • SMTP

    • SMTPS

    • SSH

    • SSL

    • VNC

    • ANY (semua jenis aplikasi)

    HTTP
    HitTimes

    integer

    Jumlah kali kebijakan dicocokkan.

    100
    Description

    string

    Deskripsi kebijakan.

    test
    SourceGroupType

    string

    Jenis Buku alamat sumber. Nilai yang valid:

    • ip: Buku alamat yang berisi satu atau beberapa Blok CIDR.

    • tag: Buku alamat tag ECS yang berisi alamat IP dari Instance ECS dengan satu atau beberapa tag.

    • domain: Buku alamat nama domain yang berisi satu atau beberapa Nama domain.

    • threat: Buku alamat intelijen ancaman yang berisi satu atau beberapa alamat IP atau Nama domain berbahaya.

    • backsrc: Buku alamat Alamat IP asal yang berisi Alamat IP asal dari satu atau beberapa Instance Anti-DDoS atau WAF.

    ip
    DnsResultTime

    integer

    Waktu saat Nama domain diselesaikan. Ini adalah Stempel waktu UNIX dalam satuan detik.

    1579261141
    DnsResult deprecated

    string

    Hasil resolusi DNS.

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

    string

    Protokol. Nilai yang valid:

    • ANY

    • TCP

    • UDP

    • ICMP

    TCP
    DestinationGroupType

    string

    Jenis Buku alamat tujuan. Nilai yang valid:

    • ip: Buku alamat yang berisi satu atau beberapa Blok CIDR.

    • tag: Buku alamat tag ECS yang berisi alamat IP dari Instance ECS dengan satu atau beberapa tag.

    • domain: Buku alamat nama domain yang berisi satu atau beberapa Nama domain.

    • threat: Buku alamat intelijen ancaman yang berisi satu atau beberapa alamat IP atau Nama domain berbahaya.

    • backsrc: Buku alamat Alamat IP asal yang berisi Alamat IP asal dari satu atau beberapa Instance Anti-DDoS atau WAF.

    ip
    Destination

    string

    Alamat tujuan. Nilai parameter ini bergantung pada nilai `DestinationType`. Nilai yang valid:

    • Jika DestinationType diatur ke net, nilai parameter ini adalah Blok CIDR. Contoh: 192.0.XX.XX/24.

    • Jika DestinationType diatur ke domain, nilai parameter ini adalah Nama domain. Contoh: aliyuncs.com.

    • Jika DestinationType diatur ke group, nilai parameter ini adalah nama Buku alamat. Contoh: db_group.

    • Jika DestinationType diatur ke location, nilai parameter ini adalah lokasi. Contoh: ["BJ11", "ZB"]. Untuk informasi selengkapnya tentang kode lokasi, lihat AddControlPolicy.

    192.0.XX.XX/24
    HitLastTime

    integer

    Waktu terakhir kebijakan dicocokkan. Ini adalah Stempel waktu UNIX dalam satuan detik.

    1579261141
    DestPortGroup

    string

    Nama Buku alamat port tujuan.

    my_port_group
    AclUuid

    string

    ID unik kebijakan.

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

    string

    Jenis port tujuan. Nilai yang valid:

    • port: Port

    • group: Buku alamat port

    port
    Source

    string

    Alamat sumber. Nilai yang valid:

    • Jika SourceType diatur kenet, nilai parameter ini adalah Blok CIDR. Contoh: 192.0.XX.XX/24.

    • Jika SourceType diatur kegroup, nilai parameter ini adalah nama Buku alamat. Contoh: db_group.

    • Jika SourceType diatur kelocation, nilai parameter ini adalah lokasi. Contoh: ["BJ11", "ZB"]. Untuk informasi selengkapnya tentang kode lokasi, lihat AddControlPolicy.

    192.0.XX.XX/24
    DestinationType

    string

    Jenis alamat tujuan. Nilai yang valid:

    • net: Blok CIDR

    • group: Buku alamat

    • domain: Nama domain

    • location: lokasi

    net
    DestPort

    string

    Port tujuan.

    80
    IpVersion

    integer

    Versi IP. Nilai yang valid:

    • 4: IPv4

    • 6: IPv6

    6
    AclAction

    string

    Aksi yang dilakukan Cloud Firewall terhadap traffic yang sesuai dengan kebijakan. Nilai yang valid:

    • accept: mengizinkan traffic.

    • drop: menolak traffic.

    • log: memantau traffic.

    accept
    Release

    string

    Status kebijakan. Kebijakan diaktifkan secara default setelah dibuat. Nilai yang valid:

    • true: diaktifkan

    • false: dinonaktifkan

    true
    ApplicationId

    string

    ID aplikasi.

    10***
    DestinationGroupCidrs

    array

    Blok CIDR dalam Buku alamat tujuan.

    string

    Blok CIDR dalam Buku alamat tujuan.

    192.0.XX.XX/24
    DestPortGroupPorts

    array

    Port dalam Buku alamat port tujuan.

    string

    Port dalam Buku alamat port tujuan.

    80/80
    SourceGroupCidrs

    array

    Blok CIDR dalam Buku alamat sumber.

    string

    Blok CIDR dalam Buku alamat sumber.

    192.0.XX.XX/24
    ApplicationNameList

    array

    Nama aplikasi.

    string

    Jenis aplikasi yang didukung oleh kebijakan. Nilai yang valid:

    • FTP

    • HTTP

    • HTTPS

    • Memcache

    • MongoDB

    • MQTT

    • MySQL

    • RDP

    • Redis

    • SMTP

    • SMTPS

    • SSH

    • SSL

    • VNC

    • ANY (semua jenis aplikasi)

    HTTP
    SpreadCnt

    integer

    Kuota yang dikonsumsi oleh kebijakan. Kuota yang dikonsumsi oleh satu kebijakan dihitung menggunakan rumus berikut: Jumlah alamat sumber × Jumlah alamat tujuan × Jumlah range port × Jumlah aplikasi.

    10000
    CreateTime

    integer

    Waktu saat kebijakan dibuat.

    1761062400
    ModifyTime

    integer

    Waktu saat kebijakan terakhir dimodifikasi.

    1761062400
    RepeatType

    string

    Jenis pengulangan untuk kebijakan. Nilai yang valid:

    • Permanent (default): Kebijakan selalu berlaku.

    • None: Kebijakan berlaku untuk periode tertentu.

    • Daily: Kebijakan berlaku setiap hari.

    • Weekly: Kebijakan berlaku setiap minggu.

    • Monthly: Kebijakan berlaku setiap bulan.

    Valid values:

    • Daily :

      Kebijakan berlaku setiap hari.

    • Monthly :

      Kebijakan berlaku setiap bulan.

    • Permanent :

      Kebijakan selalu berlaku.

    • Weekly :

      Kebijakan berlaku setiap minggu.

    • None :

      Kebijakan berlaku untuk periode tertentu.

    Permanent
    RepeatDays

    array

    Hari dalam seminggu atau sebulan ketika kebijakan berlaku secara berulang.

    • Jika RepeatType diatur ke Permanent, None, atau Daily, parameter ini adalah array kosong. Contoh: []

    • Jika RepeatType diatur ke Weekly, parameter ini tidak kosong. Contoh: [0, 6]

    Catatan

    Jika `RepeatType` diatur ke `Weekly`, nilai dalam array tidak boleh berulang.

    • Jika RepeatType diatur ke Monthly, parameter ini tidak kosong. Contoh: [1, 31]

    Catatan

    Jika `RepeatType` diatur ke `Monthly`, nilai dalam array tidak boleh berulang.

    integer

    Hari dalam seminggu atau sebulan.

    Catatan

    Jika RepeatType diatur ke Weekly, nilai yang valid adalah 0 hingga 6. Minggu dimulai pada hari Minggu. Jika RepeatType diatur ke Monthly, nilai yang valid adalah 1 hingga 31.

    1
    RepeatStartTime

    string

    Waktu mulai pengulangan. Waktu dalam format HH:mm. Waktu harus tepat pada jam atau setengah jam, dan minimal 30 menit sebelum waktu berakhir.

    Catatan

    Jika RepeatType diatur ke Permanent atau None, parameter ini kosong. Jika RepeatType diatur ke Daily, Weekly, atau Monthly, Anda harus mengatur parameter ini.

    08:00
    RepeatEndTime

    string

    Waktu akhir pengulangan. Waktu dalam format HH:mm. Waktu harus tepat pada jam atau setengah jam, dan minimal 30 menit setelah waktu mulai.

    Catatan

    Jika RepeatType diatur ke Permanent atau None, parameter ini kosong. Jika RepeatType diatur ke Daily, Weekly, atau Monthly, Anda harus mengatur parameter ini.

    23:30
    StartTime

    integer

    Waktu mulai periode validitas kebijakan. Ini adalah Stempel waktu UNIX. Waktu harus tepat pada jam atau setengah jam, dan minimal 30 menit sebelum waktu berakhir.

    Catatan

    Jika RepeatType diatur ke Permanent, parameter ini kosong. Jika RepeatType diatur ke None, Daily, Weekly, atau Monthly, Anda harus mengatur parameter ini.

    1694761200
    EndTime

    integer

    Waktu akhir periode validitas kebijakan. Ini adalah Stempel waktu UNIX. Waktu harus tepat pada jam atau setengah jam, dan minimal 30 menit setelah waktu mulai.

    Catatan

    Jika RepeatType diatur ke Permanent, parameter ini kosong. Jika RepeatType diatur ke None, Daily, Weekly, atau Monthly, Anda harus mengatur parameter ini.

    1694764800
    DomainResolveType

    string

    Metode resolusi nama domain untuk kebijakan. Nilai yang valid:

    • FQDN: berdasarkan FQDN

    • DNS: berdasarkan resolusi DNS dinamis

    • FQDN_AND_DNS: berdasarkan FQDN dan resolusi DNS dinamis

    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.