All Products
Search

This Product

    Web Application Firewall:DescribeApisecApiResources

    Document Center

    Web Application Firewall:DescribeApisecApiResources

    Last Updated:Jul 07, 2026

    Mengkueri daftar aset keamanan API.

    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

    Anda dapat memanggil DescribeInstance untuk memperoleh ID instans WAF saat ini.

    waf_v2_public_cn-u***gr20j
    ApiId

    string

    No

    ID API.

    867ade***24ee6e205b8da82b8f84
    ApiFormat

    string

    No

    Operasi API.

    /auth/login
    MatchedHost

    string

    No

    Nama domain atau alamat IP tempat operasi API berada.

    a.aliyun.com
    SensitiveType

    string

    No

    Tipe data sensitif dalam tanggapan.

    Catatan

    Anda dapat memanggil DescribeApisecRules untuk memperoleh tipe data sensitif yang didukung.

    1004
    ApiStatus

    string

    No

    Status API. Nilai valid:

    • NewbornInterface: baru ditambahkan.

    • OfflineInterface: tidak aktif.

    • normal: normal.

    OfflineInterface
    StartTime

    string

    No

    Waktu mulai pengatur waktu kueri, dalam format stempel waktu UNIX (UTC). Unit: detik.

    1681833600
    EndTime

    string

    No

    Waktu akhir pengatur waktu kueri, dalam format stempel waktu UNIX (UTC). Unit: detik.

    1683388800
    OrderKey

    string

    No

    Nama bidang yang digunakan untuk Pengurutan. Nilai valid:

    • allCnt: total volume akses dalam 30 hari terakhir.

    • botCnt: volume akses bot dalam 30 hari terakhir.

    • crossBorderCnt: volume akses lintas batas dalam 30 hari terakhir.

    • abnormalNum: jumlah risiko yang terkait dengan API.

    • eventNum: jumlah peristiwa yang terkait dengan API.

    • farthestTs: waktu penemuan pertama.

    • lastestTs: waktu akses paling baru.

    allCnt
    OrderWay

    string

    No

    Urutan pengurutan. Nilai valid:

    • desc: urutan menurun (default).

    • asc: urutan menaik.

    desc
    PageNumber

    integer

    No

    Nomor halaman yang dikembalikan dalam kueri berhalaman. Nilai default: 1, yang menunjukkan bahwa halaman pertama dikembalikan.

    1
    PageSize

    integer

    No

    Jumlah entri yang dikembalikan pada setiap halaman dalam kueri berhalaman. Nilai default: 10, yang menunjukkan bahwa setiap halaman berisi 10 entri.

    10
    Follow

    integer

    No

    Apakah API diikuti. Nilai valid:

    • 1: diikuti.

    • 0: tidak diikuti.

    0
    ApiType

    string

    No

    Objek layanan. Nilai valid:

    • PublicAPI: layanan publik.

    • ThirdpartAPI: kolaborasi pihak ketiga.

    • InternalAPI: kantor internal.

    innerAPI
    ApiTag

    string

    No

    Tujuan bisnis API.

    Catatan

    Anda dapat memanggil DescribeApisecRules untuk memperoleh tujuan bisnis yang didukung.

    SendMail
    SensitiveLevel

    string

    No

    Tingkat sensitivitas API. Nilai valid:

    • L1: sensitivitas tinggi.

    • L2: sensitivitas menengah.

    • L3: sensitivitas rendah.

    • N: tidak sensitif.

    L3
    ApiMethod

    string

    No

    Metode permintaan API. Nilai valid:

    • GET: permintaan GET.

    • POST: permintaan POST.

    • HEAD: permintaan HEAD.

    • PUT: permintaan PUT.

    • DELETE: permintaan DELETE.

    • CONNECT: permintaan CONNECT.

    • PATCH: permintaan PATCH.

    • OPTIONS: permintaan OPTIONS.

    POST
    ClusterId

    string

    No

    ID Kluster Cloud Hibrida.

    Catatan

    Parameter ini hanya berlaku untuk skenario Cloud Hibrida. Anda dapat memanggil DescribeHybridCloudClusters untuk memperoleh informasi Kluster Cloud Hibrida.

    740
    Note

    string

    No

    Keterangan.

    loginApi
    RequestSensitiveType

    string

    No

    Tipe informasi sensitif dalam permintaan.

    Catatan

    Anda dapat memanggil DescribeApisecRules untuk memperoleh tipe informasi sensitif yang didukung.

    1004,1005
    AuthFlag

    string

    No

    Apakah API memiliki bidang otentikasi. Nilai valid:

    • 0: memiliki otentikasi.

    • 1: tidak memiliki otentikasi.

    0
    RegionId

    string

    No

    Wilayah tempat instans WAF diterapkan. Nilai valid:

    • cn-hangzhou: Tiongkok Daratan.

    • ap-southeast-1: luar Tiongkok Daratan.

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    No

    ID kelompok sumber daya Alibaba Cloud.

    rg-acfm***q

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan.

    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.

    EventNum

    integer

    Jumlah peristiwa keamanan yang terkait dengan API.

    2
    FarthestTs

    integer

    Waktu pengatur waktu aset API pertama kali ditemukan, dalam format stempel waktu UNIX (UTC). Unit: detik.

    1683388800
    ApiSensitive

    string

    Informasi sensitif yang terlibat dalam API, yaitu string yang dikonversi dari objek JSON yang dibangun dengan serangkaian parameter. Parameter meliputi:

    • request_sensitive_list: daftar tipe data sensitif dalam permintaan.

    • response_sensitive_list: daftar tipe data sensitif dalam tanggapan.

    • sensitive_list: daftar tipe data sensitif.

    • sensitive_level: tingkat sensitivitas.

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

    string

    Operasi API.

    /v1/etl/finddatabyvid
    ApiTag

    string

    Tujuan bisnis API.

    Catatan

    Anda dapat memanggil DescribeApisecRules untuk memperoleh tujuan bisnis yang didukung.

    SendMail
    CrossBorderCnt

    integer

    Volume akses lintas batas dalam 30 hari terakhir.

    2
    AuthFlag

    string

    Apakah API memiliki bidang otentikasi. Nilai valid:

    • 0: memiliki otentikasi.

    • 1: tidak memiliki otentikasi.

    1
    AllCnt

    integer

    Total volume akses dalam 30 hari terakhir.

    1683388800
    ApiMethod

    string

    Metode permintaan API. Nilai valid:

    • GET: permintaan GET.

    • POST: permintaan POST.

    • HEAD: permintaan HEAD.

    • PUT: permintaan PUT.

    • DELETE: permintaan DELETE.

    • CONNECT: permintaan CONNECT.

    • PATCH: permintaan PATCH.

    • OPTIONS: permintaan OPTIONS.

    POST
    LastestTs

    integer

    Waktu pengatur waktu akses paling baru dari aset API, dalam format stempel waktu UNIX (UTC). Unit: detik.

    1683388800
    ApiStatus

    string

    Status API. Nilai valid:

    • NewbornInterface: baru ditambahkan.

    • OfflineInterface: tidak aktif.

    • normal: normal.

    NewbornInterface
    ApiSensitiveResponse

    string

    Data sensitif dalam tanggapan API.

    ["1002","1005"]
    BotCnt

    integer

    Volume akses bot dalam 30 hari terakhir.

    2
    Follow

    integer

    Apakah API diikuti. Nilai valid:

    • 1: diikuti.

    • 0: tidak diikuti.

    1
    MatchedHost

    string

    Nama domain atau alamat IP tempat operasi API berada.

    a.aliyun.com
    ApiInfo

    string

    Informasi API, yaitu string yang dikonversi dari objek JSON yang dibangun dengan serangkaian parameter. Parameter meliputi:

    • param_num: jumlah parameter API.

    • request_method: metode permintaan.

    • protocol: protokol permintaan.

    • api_url: URL permintaan.

    • poc_payload: permintaan.

    • request: sampel permintaan.

    • response: sampel tanggapan.

    • param: parameter permintaan.

    Catatan

    Bidang ini hanya dikembalikan jika parameter ApiId ditentukan.

    { "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 risiko yang terkait dengan API.

    2
    ApiType

    string

    Objek layanan. Nilai valid:

    • PublicAPI: layanan publik.

    • ThirdpartAPI: kolaborasi pihak ketiga.

    • InternalAPI: kantor internal.

    PublicAPI
    Note

    string

    Keterangan.

    loginApi
    ApiId

    string

    ID API.

    197b52abcd81d6a8bd4***e477
    Examples deprecated

    array

    Daftar sampel API.

    string

    Informasi sampel, yaitu string yang dikonversi dari objek JSON yang dibangun dengan serangkaian parameter. Parameter meliputi:

    • param_num: jumlah parameter API.

    • request_method: metode permintaan.

    • protocol: protokol permintaan.

    • api_url: URL permintaan.

    • poc_payload: permintaan.

    • request: sampel permintaan.

    • response: sampel tanggapan.

    • param: parameter permintaan.

    Catatan

    Bidang ini hanya dikembalikan jika parameter ApiId ditentukan.

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

    Data sensitif dalam permintaan API.

    ["1002","1005"]
    Resources

    array

    Daftar objek yang dilindungi yang sesuai dengan aset.

    string

    Objek yang dilindungi yang sesuai dengan aset.

    ***.top-waf
    AccountEventNum

    integer

    Jumlah peristiwa keamanan akun yang terkait dengan aset.

    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.