ConfigSetList API Overview for Direct Mail - Direct Mail - Alibaba Cloud - Direct Mail

Lists configuration sets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dm:ConfigSetList

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageIndex	string	No	The page number, starting from 1. Required.	1
PageSize	string	No	The number of entries per page. Required.	10
Keyword	string	No	The keyword used to search by name.	xxx
All	boolean	No	Specifies whether to query all configuration sets. Optional.	false

Response elements

Element	Type	Description	Example
	object	The response.
TotalCounts	integer	The total number of entries that match the request conditions.	5
RequestId	string	The request ID.	xxx
CurrentPage	integer	The current page number.	1
HasMore	boolean	Indicates whether there is a next page. Valid values: true : yes. false : no.	false
PageSize	integer	The page size.	10
ConfigSets	array<object>	The list of configuration sets.
	array<object>	The configuration set information.
Id	string	The configuration set ID.	xxx
Name	string	The configuration set name.	xxx
IpPool	object	The IP pool.
IpPoolId	string	The associated IP pool ID.	xxx
IpPoolName	string	The associated IP pool name.	xxx
FromAddresses	array	The list of associated sender addresses.
	string	The sender address.	xxx@xxx.com
Description	string	The description.	xxx
IsPublicChannelBackoff	boolean	Specifies whether to fall back to the public channel for sending when the associated dedicated IP pool encounters issues. true (backoff): The system excludes dedicated IPs that are currently throttled or blacklisted by the target mailbox provider during each delivery attempt, and preferentially uses the remaining available IPs in the pool. When all IPs in the pool are throttled or blacklisted by the target mailbox provider, the system automatically switches to the public channel to ensure delivery success rates. After the throttling or blacklisting is lifted, the system automatically resumes using dedicated IPs. false (no backoff): Only the associated dedicated IP pool is used for sending. When IPs in the pool are throttled or blacklisted, the system continues to use these IPs for delivery, which may cause delivery failures or delays. However, this ensures that the sending IPs are always your dedicated IPs.	true
ValidationOption	object	The address validation options.
Enabled	boolean	Indicates whether the address validation feature is enabled. true: Enabled. This corresponds to the BASIC_ONLY mode of the ValidateEmail operation. false: Disabled.	true
ForbiddenStatusList	array	The list of recipient address validation primary statuses to block. Before sending, the system pre-validates the recipient address. Emails whose validation primary status matches an entry in this list are rejected.
	string	The recipient address validation primary status to block. Valid values: INVALID: The address is invalid or does not exist. CATCH_ALL: The address is a catch-all address. Any mailbox under the domain can receive emails, and the actual existence of the address cannot be confirmed. DO_NOT_MAIL: The address can receive emails but is not recommended for sending, such as role accounts or disposable mailboxes. UNKNOWN: The validation result cannot be provided. If an unknown value is passed, InvalidParameter is returned.	INVALID
ForbiddenSubStatusList	array	The list of recipient address validation sub-statuses to block. This provides finer-grained blocking control than the primary statuses. It takes effect as a union with ForbiddenStatusList (emails matching either list are blocked).
	string	The recipient address validation sub-status to block. Valid values: NO_DNS_ENTRIES: Invalid address. No DNS records exist. MISSPELLED: Invalid address. The address is misspelled. DOES_NOT_ACCEPT_MAIL: Invalid address. The mail server does not accept emails. MAILBOX_NOT_EXISTS: Invalid address. The mailbox does not exist. SYSTEM_ERROR: Unknown status. A system fault occurred. MX_FORWARD: Abnormal address. MX forwarding is configured. SYNTAX_INVALID: Invalid address. A syntax error exists. ROLE_ACCOUNT: Abnormal address. The address is a role account, such as role@, info@, or contact@. SMTP_CONNECT_FAILED: Unknown status. Failed to connect to the remote SMTP server. DISABLED: Invalid address. The mailbox has been disabled. UNSPECIFIED: Unspecified. This may be returned for valid, catch-all, or unknown statuses. IP_UNROUTABLE: Invalid address. The mail server IP is unreachable. GRAY_LIST: Unknown status. The address is on a greylist. MAILBOX_FULL: Invalid address. The mailbox is full. DISPOSABLE: Abnormal address. The address is a disposable mailbox on a blacklist. TIMEOUT_EXCEEDED: Unknown status. The specified timeout period was exceeded. If an unknown value is passed, InvalidParameter is returned.	DISPOSABLE

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.