调用ConfigSetList获取配置集列表-邮件推送-阿里云-邮件推送(Direct Mail)-阿里云帮助中心

列出配置集列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dm:ConfigSetList

none

*全部资源

*

无

请求语法

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"
        ]
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。