ConfigSetList - Direct Mail: Central de Documentação do Alibaba Cloud

Lista conjuntos de configurações.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dm:ConfigSetList

none

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageIndex	string	Não	O número da página, começando em 1. Obrigatório.	1
PageSize	string	Não	O número de entradas por página. Obrigatório.	10
Keyword	string	Não	A palavra-chave usada para pesquisar por nome.	xxx
All	boolean	Não	Especifica se todos os conjuntos de configurações devem ser consultados. Opcional.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
TotalCounts	integer	O número total de entradas que correspondem às condições da solicitação.	5
RequestId	string	O ID da solicitação.	xxx
CurrentPage	integer	O número da página atual.	1
HasMore	boolean	Indica se há uma próxima página. Valores válidos: true : sim. false : no.	false
PageSize	integer	O tamanho da página.	10
ConfigSets	array<object>	A lista de conjuntos de configurações.
	array<object>	As informações do conjunto de configurações.
Id	string	O ID do conjunto de configurações.	xxx
Name	string	O nome do conjunto de configurações.	xxx
IpPool	object	O pool de IPs.
IpPoolId	string	O ID do pool de IPs associado.	xxx
IpPoolName	string	O nome do pool de IPs associado.	xxx
FromAddresses	array	A lista de endereços de remetente associados.
	string	O endereço do remetente.	xxx@xxx.com
Description	string	A descrição.	xxx
IsPublicChannelBackoff	boolean	Especifica se deve haver fallback para o canal público de envio quando o pool de IPs dedicados associado encontrar problemas. true (backoff): O sistema exclui IPs dedicados que estão atualmente limitados ou bloqueados pelo provedor de caixa de correio de destino durante cada tentativa de entrega e usa preferencialmente os IPs disponíveis restantes no pool. Quando todos os IPs do pool são limitados ou bloqueados pelo provedor de caixa de correio de destino, o sistema muda automaticamente para o canal público para garantir as taxas de sucesso de entrega. Após a remoção da limitação ou do bloqueio, o sistema retoma automaticamente o uso de IPs dedicados. false (sem backoff): Apenas o pool de IPs dedicados associado é usado para envio. Quando os IPs do pool são limitados ou bloqueados, o sistema continua a usar esses IPs para entrega, o que pode causar falhas ou atrasos na entrega. No entanto, isso garante que os IPs de envio sejam sempre seus IPs dedicados.	true
ValidationOption	object	As opções de validação de endereço.
Enabled	boolean	Indica se o recurso de validação de endereço está ativado. true: Ativado. Isso corresponde ao modo BASIC_ONLY da operação ValidateEmail. false: Desativado.	true
ForbiddenStatusList	array	A lista de status primários de validação de endereço de destinatário a serem bloqueados. Antes do envio, o sistema pré-valida o endereço do destinatário. E-mails cujo status primário de validação corresponda a uma entrada nesta lista são rejeitados.
	string	O status primário de validação de endereço de destinatário a ser bloqueado. Valores válidos: INVALID: O endereço é inválido ou não existe. CATCH_ALL: O endereço é um endereço catch-all. Qualquer caixa de correio sob o domínio pode receber e-mails, e a existência real do endereço não pode ser confirmada. DO_NOT_MAIL: O endereço pode receber e-mails, mas não é recomendado para envio, como contas de função ou caixas de correio descartáveis. UNKNOWN: O resultado da validação não pode ser fornecido. Se um valor desconhecido for passado, InvalidParameter será retornado.	INVALID
ForbiddenSubStatusList	array	A lista de substatus de validação de endereço de destinatário a serem bloqueados. Isso fornece um controle de bloqueio mais granular do que os status primários. Entra em vigor como uma união com ForbiddenStatusList (e-mails correspondentes a qualquer uma das listas são bloqueados).
	string	O substatus de validação de endereço de destinatário a ser bloqueado. Valores válidos: NO_DNS_ENTRIES: Endereço inválido. Não existem registros DNS. MISSPELLED: Endereço inválido. O endereço está incorreto. DOES_NOT_ACCEPT_MAIL: Endereço inválido. O servidor de e-mail não aceita mensagens. MAILBOX_NOT_EXISTS: Endereço inválido. A caixa de correio não existe. SYSTEM_ERROR: Status desconhecido. Ocorreu uma falha no sistema. MX_FORWARD: Endereço anormal. O encaminhamento MX está configurado. SYNTAX_INVALID: Endereço inválido. Existe um erro de sintaxe. ROLE_ACCOUNT: Endereço anormal. O endereço é uma conta de função, como role@, info@ ou contact@. SMTP_CONNECT_FAILED: Status desconhecido. Falha ao conectar ao servidor SMTP remoto. DISABLED: Endereço inválido. A caixa de correio foi desativada. UNSPECIFIED: Não especificado. Isso pode ser retornado para status válidos, catch-all ou desconhecidos. IP_UNROUTABLE: Endereço inválido. O IP do servidor de e-mail está inacessível. GRAY_LIST: Status desconhecido. O endereço está em uma greylist. MAILBOX_FULL: Endereço inválido. A caixa de correio está cheia. DISPOSABLE: Endereço anormal. O endereço é uma caixa de correio descartável em uma lista de bloqueio. TIMEOUT_EXCEEDED: Status desconhecido. O período de tempo limite especificado foi excedido. Se um valor desconhecido for passado, InvalidParameter será retornado.	DISPOSABLE

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.