ConfigSetList - Direct Mail - Alibaba Cloud Documentation Center

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 index. The value starts from 1. This parameter is required.	1
PageSize	string	No	The number of entries per page. This parameter is required.	10
Keyword	string	No	The keyword to search by name.	xxx
All	boolean	No	Specifies whether to query all configuration sets. This parameter is optional.	false

Response elements

Element	Type	Description	Example
	object	The response.
TotalCounts	integer	The total number of entries that match the request.	5
RequestId	string	The request ID.	xxx
CurrentPage	integer	The current page number.	1
HasMore	boolean	Indicates whether a next page of results exists. Valid values: true : Yes false : No	false
PageSize	integer	The number of entries per page.	10
ConfigSets	array<object>	The list of configuration sets.
	array<object>	The information about a configuration set.
Id	string	The ID of the configuration set.	xxx
Name	string	The name of the configuration set.	xxx
IpPool	object	The IP pool information.
IpPoolId	string	The ID of the associated IP pool.	xxx
IpPoolName	string	The name of the associated IP pool.	xxx
FromAddresses	array	The list of associated sender addresses.
	string	The sender address.	xxx@xxx.com
Description	string	The description.	xxx

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.