GetSiteWafSettings - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

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

esa:GetSiteWafSettings

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Não	O ID do site, que pode ser obtido chamando a API ListSites.	1
SiteVersion	integer	Não	A versão do site.	0
Path	string	Não	Especifica o caminho da configuração. Se não for fornecido, todas as configurações serão recuperadas. Valores válidos: bot_management : Bots no modo simples. add_security_headers : Adição de cabeçalhos de resposta de segurança. client_ip_identifier : Definição do IP do cliente. add_bot_protection_headers : Adição de cabeçalhos de solicitação de segurança. security_level : Nível de segurança.	bot_management

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Resultado da resposta.
RequestId	string	O ID da solicitação.	36af3fcc-43d0-441c-86b1-428951dc8225
Settings	WafSiteSettings	Os detalhes da configuração do WAF do site.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Settings": {
    "ClientIpIdentifier": {
      "Mode": "headers",
      "Headers": [
        "X-Forwarded-For"
      ]
    },
    "AddBotProtectionHeaders": {
      "Enable": false
    },
    "AddSecurityHeaders": {
      "Enable": false
    },
    "SecurityLevel": {
      "Value": "low"
    },
    "BotManagement": {
      "DefiniteBots": {
        "Id": 20000001,
        "Action": "captcha"
      },
      "LikelyBots": {
        "Id": 20000002,
        "Action": "deny"
      },
      "VerifiedBots": {
        "Id": 20000003,
        "Action": "bypass"
      },
      "JSDetection": {
        "Enable": false
      },
      "EffectOnStatic": {
        "Enable": true
      }
    },
    "BandwidthAbuseProtection": {
      "Id": 10000001,
      "Status": "on",
      "Action": "deny"
    },
    "DisableSecurityModule": {
      "Status": "on"
    },
    "RequestBodyInspection": {
      "Id": 0,
      "SizeLimit": "",
      "Action": ""
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.