調用ConfigSetList API擷取配置集列表-Direct Mail-阿里雲 - Direct Mail

列出配置集清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dm:ConfigSetList

none

*All Resource

*

無

請求文法

GET  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
PageIndex	string	否	分頁索引，從 1 開始。必填。	1
PageSize	string	否	每頁數目，必填。	10
Keyword	string	否	名稱搜尋關鍵字。	xxx
All	boolean	否	查詢所有，選填。	false

返回參數

名稱	類型	描述	樣本值
	object	回應。
TotalCounts	integer	本次請求條件下的資料總量。	5
RequestId	string	請求 ID。	xxx
CurrentPage	integer	當前頁。	1
HasMore	boolean	是否有下一頁。枚舉值： true : 是。 false : 否。	false
PageSize	integer	分頁大小。	10
ConfigSets	array<object>	配置集清單。
	array<object>	配置集資訊。
Id	string	配置集 ID。	xxx
Name	string	配置集名稱。	xxx
IpPool	object	IP 集區。
IpPoolId	string	關聯 IP 集區 ID。	xxx
IpPoolName	string	關聯 IP 集區名稱。	xxx
FromAddresses	array	關聯寄件地址清單。
	string	寄件地址。	xxx@xxx.com
Description	string	描述。	xxx
IsPublicChannelBackoff	boolean	關聯的獨立 IP 集區出現問題時，是否退避使用公共通道傳送。 true（退避）：系統在每次投遞時會剔除當前對目標信箱服務商被流控或列黑的獨立 IP，優先使用集區內其餘可用 IP 傳送；當集區內 IP 對該信箱服務商全部被流控或列黑時，自動改用公共通道傳送，保障投遞成功率。流控或列黑解除後自動恢復使用獨立 IP。 false（不退避）：僅使用關聯的獨立 IP 集區傳送；集區內 IP 被流控或列黑時仍繼續使用這些 IP 投遞，可能導致投遞失敗或延遲，但可確保寄件 IP 始終為您的獨立 IP。	true
ValidationOption	object	地址驗證功能選項。
Enabled	boolean	地址驗證功能是否啟用。 true：啟用。是地址驗證介面 ValidateEmail 介面的 BASIC_ONLY 模式。 false：不啟用。	true
ForbiddenStatusList	array	需要攔截的收件人地址驗證主狀態清單。寄件前系統對收件人地址做預驗證，驗證結果主狀態命中本清單的郵件將被拒絕傳送。
	string	需要攔截的收件人地址驗證主狀態。取值： INVALID: 無效地址或地址不存在。 CATCH_ALL: Catch-all 地址，網域下任意信箱均可收信，無法確定地址真實存在。 DO_NOT_MAIL：可收信但不建議傳送，如角色帳號/一次性信箱。 UNKNOWN：無法提供驗證結果。傳入未知取值將返回 InvalidParameter。	INVALID
ForbiddenSubStatusList	array	需要攔截的收件人地址驗證子狀態清單，提供比主狀態更細粒度的攔截控制，與 ForbiddenStatusList 取聯集生效（命中任一清單即攔截）。
	string	需要攔截的收件人地址驗證子狀態。取值： NO_DNS_ENTRIES : 無效地址，沒有 DNS 記錄。 MISSPELLED : 無效地址，拼寫錯誤。 DOES_NOT_ACCEPT_MAIL : 無效地址，郵件伺服器不接受郵件。 MAILBOX_NOT_EXISTS : 無效地址，信箱不存在。 SYSTEM_ERROR : 未知狀態，系統錯誤。 MX_FORWARD : 非正常地址，MX 轉發。 SYNTAX_INVALID : 無效地址，語法錯誤。 ROLE_ACCOUNT : 非正常地址，角色帳號，例如 role@ info@ contact@ 等。 SMTP_CONNECT_FAILED : 未知狀態，連線對方 SMTP 伺服器失敗。 DISABLED : 無效地址，信箱已被停用。 UNSPECIFIED : 沒有說明，有效、CatchAll、未知狀態可能返回。 IP_UNROUTABLE : 無效地址，郵件伺服器 IP 不可達。 GRAY_LIST : 未知狀態，灰名單 MAILBOX_FULL : 無效地址，信箱已滿 DISPOSABLE : 非正常地址，臨時信箱，黑名單庫。 TIMEOUT_EXCEEDED : 未知狀態，超過指定的逾時時間。傳入未知取值將返回 InvalidParameter。	DISPOSABLE

樣本

正常返回樣本

JSON格式

{
  "TotalCounts": 5,
  "RequestId": "xxx",
  "CurrentPage": 1,
  "HasMore": false,
  "PageSize": 10,
  "ConfigSets": [
    {
      "Id": "xxx",
      "Name": "xxx",
      "IpPool": {
        "IpPoolId": "xxx",
        "IpPoolName": "xxx"
      },
      "FromAddresses": [
        "xxx@xxx.com"
      ],
      "Description": "xxx",
      "IsPublicChannelBackoff": true,
      "ValidationOption": {
        "Enabled": true,
        "ForbiddenStatusList": [
          "INVALID"
        ],
        "ForbiddenSubStatusList": [
          "DISPOSABLE"
        ]
      }
    }
  ]
}

錯誤碼

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

變更歷史

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