使用DescribeGlobalSecurityIPGroup API查詢全域IP白名單模板-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢全域IP白名單模板。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeGlobalSecurityIPGroup

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所屬的地區 ID，您可以通過調用 DescribeDBInstanceAttribute 進行查詢。	cn-hangzhou
GlobalSecurityGroupId	string	否	IP 白名單模板 ID。	g-hedmu8kg9nsabw6u42rv

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求唯一 ID，如果遇到問題請提供這個請求 ID，由工作人員為您排查。	72651AF9-7897-41A7-8B67-6C15C7F26A0A
GlobalSecurityIPGroup	array<object>	全域 IP 白名單模板列表。
	object	全域 IP 白名單模板。
GlobalSecurityGroupId	string	IP 白名單模板 ID。	g-sdgwqyp4f5j1x3qk7yvm
GlobalIgName	string	IP 白名單模板名稱。	dev_baoxian_k8s_bj
GIpList	string	白名單模板內的 IP 位址。說明多個 IP 位址需要用英文逗號隔開，所有 IP 白名單累積支援添加 1000 個 IP 位址或位址區段。	117.12.202.19
RegionId	string	地區 ID。	cn-hangzhou
DBInstances	array	全域 IP 白名單模板綁定的執行個體列表。
	string	MongoDB 執行個體 Id。	[dds-asdxxxx,dds-afrexxxxxx]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "72651AF9-7897-41A7-8B67-6C15C7F26A0A",
  "GlobalSecurityIPGroup": [
    {
      "GlobalSecurityGroupId": "g-sdgwqyp4f5j1x3qk7yvm",
      "GlobalIgName": "dev_baoxian_k8s_bj",
      "GIpList": "117.12.202.19",
      "RegionId": "cn-hangzhou",
      "DBInstances": [
        "[dds-asdxxxx,dds-afrexxxxxx]"
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RequiredParam.NotFound	Required input param is not found.
400	InvalidAction	Specified action is not valid.	服務異常。
404	InvalidUser.NotFound	Specified user does not exist.

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

變更歷史

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