全部產品
Search

搜尋本產品

    Cloud Firewall：DescribeUserIPSWhitelist - 擷取使用者IPS白名單

    文件中心

    Cloud Firewall：DescribeUserIPSWhitelist - 擷取使用者IPS白名單

    更新時間：Jan 07, 2026

    查詢互連網邊界IPS白名單。

    介面說明

    QPS 限制

    本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SourceIp

    string

    否

    訪問者源 IP 位址。

    47.100.XX.XX
    Lang

    string

    否

    語言。

    枚舉值：

    • en :

      英文

    • zh :

      中文（預設）

    zh
    Lang

    string

    否

    語言。

    枚舉值：

    • en :

      英文

    • zh :

      中文（預設）

    zh

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    04F788A5-6A47-5EA9-AC30-CA4DB98AD520
    Whitelists

    array<object>

    互連網邊界 IPv4 的入侵防禦系統白名單列表。

    object

    互連網邊界 IPv4 的入侵防禦系統白名單。

    Direction

    integer

    互連網邊界的 IPv4 流量方向。

    枚舉值：

    • 1 :

      入向

    • 2 :

      出向

    1
    WhiteType

    integer

    互連網邊界 IPv4 白名單生效的源或目的類型。

    枚舉值：

    • 1 :

      目的 IP 白名單

    • 2 :

      源 IP 白名單

    1
    ListValue

    string

    互連網邊界 IPv4 白名單的值。

    • 當白名單類型為自訂輸入時：地址簿名稱。

    • 當白名單類型為地址簿引用時：IPv4。

    10.10.200.4/32,10.10.200.25/32
    ListType

    integer

    互連網 IPv4 白名單地址的類型。

    枚舉值：

    • 0 :

      暫不設定

    • 1 :

      自訂輸入

    • 2 :

      地址簿引用

    1
    WhiteListValue

    array

    互連網 IPv4 白名單列表。

    string

    互連網 IPv4 白名單。

    • 當白名單類型為自訂輸入時：地址簿名稱。

    • 當白名單類型為地址簿引用時：IPv4。

    10.10.200.4/32
    Ipv6Whitelists

    array<object>

    互連網邊界 IPv6 的入侵防禦系統白名單列表。

    object

    互連網邊界 IPv6 的入侵防禦系統白名單。

    Direction

    integer

    互連網邊界的 IPv6 流量方向。

    枚舉值：

    • 1 :

      入向

    • 2 :

      出向

    1
    WhiteType

    integer

    互連網邊界 IPv6 白名單生效的源或目的類型。

    枚舉值：

    • 1 :

      目的 IP 白名單

    • 2 :

      源 IP 白名單

    2
    ListValue

    string

    互連網邊界 IPv6 白名單的值。

    • 當白名單類型為自訂輸入時：地址簿名稱。

    • 當白名單類型為地址簿引用時：IPv6。

    2408:400a:81a:7900:a77d:ea36:fcbf:de40/128
    ListType

    integer

    互連網 IPv6 白名單地址的類型。

    枚舉值：

    • 0 :

      暫不設定

    • 1 :

      自訂輸入

    • 2 :

      地址簿引用

    0
    WhiteListValue

    array

    互連網 IPv6 白名單列表。

    string

    互連網 IPv6 白名單。

    • 當白名單類型為自訂輸入時：地址簿名稱。

    • 當白名單類型為地址簿引用時：IPv6。

    2408:400a:81a:7900:a77d:ea36:fcbf:de40/128

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "04F788A5-6A47-5EA9-AC30-CA4DB98AD520",
  "Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 1,
      "ListValue": "10.10.200.4/32,10.10.200.25/32",
      "ListType": 1,
      "WhiteListValue": [
        "10.10.200.4/32"
      ]
    }
  ],
  "Ipv6Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 2,
      "ListValue": "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128",
      "ListType": 0,
      "WhiteListValue": [
        "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128\n"
      ]
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ErrorParametersUid invalid aliUid. 無效的Aliuid。
    400 ErrorDBSelect An error occurred while querying database. 內部錯誤：資料庫查詢錯誤
    400 ErrorMarshalJSON internal error: marshal json. 請求錯誤，請稍後重試。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。