All Products
Search

This Product

    Web Application Firewall:DescribeApisecApiResources

    Document Center

    Web Application Firewall:DescribeApisecApiResources

    Last Updated:Jun 09, 2026

    Mengkueri daftar aset keamanan API yang dilindungi oleh Web Application Firewall (WAF).

    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-waf:DescribeApisecApiResources

    get

    *全部资源

    *
    • acs:ResourceGroupId
    		 None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    ID instans WAF.

    Catatan

    Panggil operasi DescribeInstance untuk mendapatkan ID instans WAF.

    waf_v2_public_cn-u***gr20j
    ApiId

    string

    No

    ID API.

    867ade***24ee6e205b8da82b8f84
    ApiFormat

    string

    No

    Jalur endpoint API yang digunakan untuk memfilter hasil kueri.

    /auth/login
    MatchedHost

    string

    No

    Nama domain atau alamat IP API yang digunakan untuk memfilter hasil kueri.

    a.aliyun.com
    SensitiveType

    string

    No

    Jenis data sensitif dalam respons.

    Catatan

    Panggil operasi DescribeApisecRules untuk mendapatkan jenis data sensitif yang didukung.

    1004
    ApiStatus

    string

    No

    Status siklus hidup API. Nilai yang valid:

    • NewbornInterface: baru ditemukan.

    • OfflineInterface: tidak aktif.

    • normal: aktif.

    OfflineInterface
    StartTime

    string

    No

    Awal rentang waktu untuk dikueri. Tentukan stempel waktu UNIX dalam detik.

    1681833600
    EndTime

    string

    No

    Akhir rentang waktu untuk dikueri. Tentukan stempel waktu UNIX dalam detik.

    1683388800
    OrderKey

    string

    No

    Bidang yang digunakan untuk mengurutkan hasil. Nilai yang valid:

    • allCnt: mengurutkan berdasarkan jumlah total permintaan dalam 30 hari terakhir.

    • botCnt: mengurutkan berdasarkan jumlah permintaan bot dalam 30 hari terakhir.

    • crossBorderCnt: mengurutkan berdasarkan jumlah permintaan lintas batas dalam 30 hari terakhir.

    • abnormalNum: mengurutkan berdasarkan jumlah ancaman yang terkait dengan API.

    • eventNum: mengurutkan berdasarkan jumlah peristiwa keamanan yang terkait dengan API.

    • farthestTs: mengurutkan berdasarkan waktu API pertama kali ditemukan.

    • lastestTs: mengurutkan berdasarkan waktu akses terbaru.

    allCnt
    OrderWay

    string

    No

    Urutan pengurutan. Nilai yang valid:

    • desc: urutan menurun (default).

    • asc: urutan menaik.

    desc
    PageNumber

    integer

    No

    Nomor halaman. Nilai default: 1.

    1
    PageSize

    integer

    No

    Jumlah entri per halaman. Nilai default: 10.

    10
    Follow

    integer

    No

    Menunjukkan apakah API diikuti. Nilai yang valid:

    • 1: API diikuti.

    • 0: API tidak diikuti.

    0
    ApiType

    string

    No

    Jenis layanan yang dilayani oleh API. Nilai yang valid:

    • PublicAPI: layanan yang menghadap publik.

    • ThirdpartAPI: layanan pihak ketiga.

    • InternalAPI: layanan internal.

    innerAPI
    ApiTag

    string

    No

    Tujuan bisnis API.

    Catatan

    Panggil operasi DescribeApisecRules untuk mendapatkan tujuan bisnis yang didukung.

    SendMail
    SensitiveLevel

    string

    No

    Tingkat sensitivitas API. Nilai yang valid:

    • L1: Tinggi.

    • L2: Sedang.

    • L3: Rendah.

    • N: Tidak sensitif.

    L3
    ApiMethod

    string

    No

    Metode permintaan HTTP dari API. Nilai yang valid: GET, POST, HEAD, PUT, DELETE, CONNECT, PATCH, dan OPTIONS.

    POST
    ClusterId

    string

    No

    ID kluster Hybrid Cloud WAF.

    Catatan

    Parameter ini hanya tersedia untuk skenario hybrid cloud. Panggil operasi DescribeHybridCloudClusters untuk mendapatkan informasi tentang kluster Hybrid Cloud WAF.

    740
    Note

    string

    No

    Keterangan aset API yang digunakan untuk memfilter hasil kueri.

    loginApi
    RequestSensitiveType

    string

    No

    Jenis data sensitif dalam permintaan.

    Catatan

    Panggil operasi DescribeApisecRules untuk mendapatkan jenis data sensitif yang didukung.

    1004,1005
    AuthFlag

    string

    No

    Menunjukkan apakah API memerlukan autentikasi. Nilai yang valid:

    • 0: API memerlukan autentikasi.

    • 1: API tidak memerlukan autentikasi.

    0
    RegionId

    string

    No

    ID wilayah instans WAF. Nilai yang valid:

    • ap-southeast-1: Tiongkok daratan.

    • ap-southeast-1: di luar Tiongkok daratan.

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    No

    ID grup sumber daya Alibaba Cloud.

    rg-acfm***q

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    TotalCount

    integer

    Jumlah total entri yang dikembalikan.

    5
    RequestId

    string

    ID permintaan.

    2EFCFE18-78F8-5079-B312-07***48B
    Data

    array<object>

    Daftar aset API.

    object

    Detail aset API.

    EventNum

    integer

    Jumlah peristiwa keamanan yang terkait dengan API.

    2
    FarthestTs

    integer

    Waktu API pertama kali ditemukan. Nilainya adalah stempel waktu UNIX. Unit: detik.

    1683388800
    ApiSensitive

    string

    Klasifikasi data sensitif API. Nilainya adalah string JSON yang berisi bidang-bidang berikut:

    • request_sensitive_list: daftar jenis data sensitif dalam permintaan.

    • response_sensitive_list: daftar jenis data sensitif dalam respons.

    • sensitive_list: daftar jenis data sensitif.

    • sensitive_level: tingkat sensitivitas.

    { "sensitive_list": ["1003","1005"], "sensitive_level": "L2", "request_sensitive_list": ["1003"], "response_sensitive_list": ["1005"] }
    ApiFormat

    string

    Jalur endpoint API.

    /v1/etl/finddatabyvid
    ApiTag

    string

    Tujuan bisnis API.

    Catatan

    Panggil operasi DescribeApisecRules untuk mendapatkan tujuan bisnis yang didukung.

    SendMail
    CrossBorderCnt

    integer

    Jumlah permintaan lintas batas dalam 30 hari terakhir.

    2
    AuthFlag

    string

    Menunjukkan apakah API memerlukan autentikasi. Nilai yang valid:

    • 0: API memerlukan autentikasi.

    • 1: API tidak memerlukan autentikasi.

    1
    AllCnt

    integer

    Jumlah total permintaan dalam 30 hari terakhir.

    1683388800
    ApiMethod

    string

    Metode permintaan HTTP dari API. Nilai yang valid: GET, POST, HEAD, PUT, DELETE, CONNECT, PATCH, dan OPTIONS.

    POST
    LastestTs

    integer

    Waktu akses terbaru ke API. Nilainya adalah stempel waktu UNIX. Unit: detik.

    1683388800
    ApiStatus

    string

    Status siklus hidup API. Nilai yang valid:

    • NewbornInterface: baru ditemukan.

    • OfflineInterface: tidak aktif.

    • normal: aktif.

    NewbornInterface
    ApiSensitiveResponse

    string

    Jenis data sensitif yang terdeteksi dalam respons API. Nilainya adalah array JSON dari ID jenis data sensitif.

    ["1002","1005"]
    BotCnt

    integer

    Jumlah permintaan bot dalam 30 hari terakhir.

    2
    Follow

    integer

    Menunjukkan apakah API diikuti. Nilai yang valid:

    • 1: API diikuti.

    • 0: API tidak diikuti.

    1
    MatchedHost

    string

    Nama domain atau alamat IP tempat API berada.

    a.aliyun.com
    ApiInfo

    string

    Informasi terperinci tentang API. Nilainya adalah string JSON yang berisi bidang-bidang berikut:

    • param_num: jumlah parameter API.

    • request_method: metode permintaan.

    • protocol: protokol permintaan.

    • api_url: URL permintaan.

    • poc_payload: permintaan.

    • request: sampel permintaan.

    • response: sampel respons.

    • param: parameter permintaan.

    Catatan

    Parameter ini dikembalikan hanya ketika Anda menentukan parameter permintaan ApiId.

    { "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
    AbnormalNum

    integer

    Jumlah ancaman yang terkait dengan API.

    2
    ApiType

    string

    Jenis layanan yang dilayani oleh API. Nilai yang valid:

    • PublicAPI: layanan yang menghadap publik.

    • ThirdpartAPI: layanan pihak ketiga.

    • InternalAPI: layanan internal.

    PublicAPI
    Note

    string

    Keterangan aset API.

    loginApi
    ApiId

    string

    ID API.

    197b52abcd81d6a8bd4***e477
    Examples deprecated

    array

    Daftar sampel API.

    string

    Informasi sampel. Nilainya adalah string JSON yang berisi bidang-bidang berikut:

    • param_num: jumlah parameter API.

    • request_method: metode permintaan.

    • protocol: protokol permintaan.

    • api_url: URL permintaan.

    • poc_payload: permintaan.

    • request: sampel permintaan.

    • response: sampel respons.

    • param: parameter permintaan.

    Catatan

    Parameter ini dikembalikan hanya ketika Anda menentukan parameter permintaan ApiId.

    { "request": {"referer": "-","content_type": "-","cookie": "-","method": "GET","param": [],"host": "test.cn"}, "protocol": "https", "api_url": "https://test.cn:443/index.php", "param": [], "response": {"param": [], "sensitive_type": {}, "header": {},"body": "", "status": 405 }, "request_method": "GET", "poc_payload": "curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'", "param_num": 0 }
    ApiSensitiveRequest

    string

    Jenis data sensitif yang terdeteksi dalam permintaan API. Nilainya adalah array JSON dari ID jenis data sensitif.

    ["1002","1005"]
    Resources

    array

    Daftar objek yang dilindungi yang terkait dengan API.

    string

    Nama objek yang dilindungi yang terkait dengan API.

    ***.top-waf
    AccountEventNum

    integer

    Jumlah peristiwa keamanan akun yang terkait dengan API.

    1

    Contoh

    Respons sukses

    JSONformat

    {
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "EventNum": 2,
      "FarthestTs": 1683388800,
      "ApiSensitive": "{\n    \"sensitive_list\": [\"1003\",\"1005\"],\n    \"sensitive_level\": \"L2\",\n    \"request_sensitive_list\": [\"1003\"],\n    \"response_sensitive_list\": [\"1005\"]\n}",
      "ApiFormat": "/v1/etl/finddatabyvid",
      "ApiTag": "SendMail",
      "CrossBorderCnt": 2,
      "AuthFlag": "1",
      "AllCnt": 1683388800,
      "ApiMethod": "POST",
      "LastestTs": 1683388800,
      "ApiStatus": "NewbornInterface",
      "ApiSensitiveResponse": "[\"1002\",\"1005\"]",
      "BotCnt": 2,
      "Follow": 1,
      "MatchedHost": "a.aliyun.com",
      "ApiInfo": "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}",
      "AbnormalNum": 2,
      "ApiType": "PublicAPI",
      "Note": "loginApi",
      "ApiId": "197b52abcd81d6a8bd4***e477",
      "Examples": [
        "{\n    \"request\": {\"referer\": \"-\",\"content_type\": \"-\",\"cookie\": \"-\",\"method\": \"GET\",\"param\": [],\"host\": \"test.cn\"},\n    \"protocol\": \"https\",\n    \"api_url\": \"https://test.cn:443/index.php\",\n    \"param\": [],\n    \"response\": {\"param\": [], \"sensitive_type\": {}, \"header\": {},\"body\": \"\", \"status\": 405 },\n    \"request_method\": \"GET\",\n    \"poc_payload\": \"curl -X GET -H 'Accept: */*' -H 'Connection: keep-alive' -H 'User-agent: python-requests/2.32.3' -H 'X-forwarded-for: {{IPv6 Address}}' -H 'Host: test.cn' -H 'Accept-encoding: gzip, deflate' 'https://test.cn:443/index.php'\",\n    \"param_num\": 0\n}"
      ],
      "ApiSensitiveRequest": "[\"1002\",\"1005\"]",
      "Resources": [
        "***.top-waf"
      ],
      "AccountEventNum": 1
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.