全部產品
Search

搜尋本產品

    Database Autonomy Service：DescribeSecurityIPGroup - 跨產品白名單模板展示介面

    文件中心

    Database Autonomy Service：DescribeSecurityIPGroup - 跨產品白名單模板展示介面

    更新時間：Apr 21, 2026

    展示使用者跨產品白名單模板具體資訊

    介面說明

    使用該介面需滿足以下前提條件：

    • 使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。

    • 在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

    調試

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

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hdm:DescribeSecurityIPGroup

    get

    *全部資源

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionName

    string

    是

    地區 ID。

    cn-shanghai

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    Code

    string

    返回的狀態代碼。

    200
    Data

    object

    ListResult

    SecurityIpGroups

    array<object>

    使用者在該 region 下的所有跨產品白名單模板列表。

    array<object>

    DbInstances

    array

    該跨產品白名單模板所繫結資料庫執行個體列表。

    string

    資料庫執行個體 ID。

    ["r-2ze9g6mnhu1***", "pc-2zew5qn1m***", "r-2ze9g6mn****", "pc-2zew5qh41*****"]
    SecurityIpType

    string

    ip 類型

    ipv4
    Uid

    string

    帳號 ID，您可在阿里雲帳號管理的安全設定頁面擷取登入帳號的 ID。

    160-79abe3f4****
    RegionId

    string

    地區 ID。

    cn-hangzhou
    GEcsSgIdList

    string

    ECS 安全性群組 ID，已無效，是冗餘資料，待下線

    null
    GlobalIgName

    string

    IP 白名單模板名稱。IP 白名單模板名稱需滿足如下要求：

    • 由小寫字母、數字、底線（_）組成。

    • 由字母開頭、字母或數字結尾。

    • 長度為 2~120 個字元。

    test_123
    GlobalSecurityGroupId

    string

    IP 白名單模板 ID。

    g-1no2rzybnqcv****
    WhitelistNetType

    string

    白名單的網路類型。

    mix
    EngineInfoList

    array<object>

    該模板所綁定的各產品下的執行個體資訊

    object

    InstanceNum

    integer

    當前登入帳號包含的執行個體數量。

    10
    EngineName

    string

    目標執行個體的資料庫類型。

    PolarDBMySQL
    InstanceIds

    array

    資料庫執行個體 ID 列表。

    string

    資料庫執行個體 ID。

    說明

    資料格式為 JSONArray，例如['執行個體 ID1','執行個體 ID2']，執行個體 ID 間用英文逗號（,）分隔。

    rm-2ze8ygcc****
    UserId

    string

    使用者 id

    641***
    GIpList

    string

    白名單模板內的 IP 位址。

    說明

    多個 IP 位址需要用英文逗號（,）分隔。

    192.168.1.28/32
    Message

    string

    請求返回的訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    RequestId

    string

    請求 ID。

    CAC553F1-C669-53F1-A295-2CF050E****
    Success

    string

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "Success": "true"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid. 請求參數錯誤
    403 NoPermission You are not authorized to do this action. 沒有許可權執行該操作

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

    變更歷史

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