DescribeDefenseResources - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta objetos protegidos por paginação.

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

yundun-waf:DescribeDefenseResources

list

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	ID da instância do WAF. null Você pode chamar a operação DescribeInstance para consultar o ID da instância do WAF.	waf_cdnsdf3****
PageNumber	integer	Não	O número da página a ser retornada ao usar paginação. Valor padrão: 1, que indica a primeira página.	1
PageSize	integer	Não	O número de entradas por página ao usar paginação. Valor padrão: 10, que indica que 10 entradas são retornadas em cada página.	10
Query	string	Não	As condições de consulta. O valor é uma string JSON. null Os resultados da consulta variam conforme as condições de consulta. Para mais informações, consulte Descrição dos parâmetros de consulta.	{\"product\":\"waf\"}
Tag	array<object>	Não	A lista de tags de recursos. É possível especificar no máximo 20 tags.
	object	Não	A tag do recurso, composta por uma chave de tag e um valor de tag.
Value	string	Não	O valor da tag.	TagValue1
Key	string	Não	A chave da tag.	Tagkey1
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
RegionId	string	Não	A região onde a instância do WAF está implantada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou

Descrição dos parâmetros de consulta

Descrição dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
product	String	Não	waf	O tipo de ativo. Valores válidos: - waf: conectado ao WAF por CNAME ou outros métodos. - alb: conectado por Application Load Balancer (ALB). - clb: conectado por Classic Load Balancer (CLB). - ecs: conectado por ECS. - mse: conectado por Microservices Engine (MSE). - fc: conectado por Function Compute (FC).
resourceLike	String	Não	example.aliyundoc.c	O nome do objeto protegido. Você pode definir este parâmetro para realizar uma consulta aproximada em objetos protegidos conectados ao WAF.
resource	String	Não	example.aliyundoc.com-waf	O nome do objeto protegido. Você pode definir este parâmetro para realizar uma consulta exata em objetos protegidos conectados ao WAF.
resourceIn	String	Não	example1.aliyundoc.com,example2.aliyundoc.com	Os nomes de múltiplos objetos protegidos. Você pode definir este parâmetro para consultar múltiplos objetos protegidos conectados ao WAF. Separe múltiplos objetos protegidos com vírgulas (,).
instanceId	String	Não	alb-nifa24****	O ID da instância do objeto protegido. Você pode definir este parâmetro para realizar uma consulta exata no ID da instância de um objeto protegido conectado ao WAF.
domain	String	Não	example.aliyundoc.com	O nome de domínio do objeto protegido. Você pode definir este parâmetro para realizar uma consulta exata no nome de domínio de um objeto protegido conectado ao WAF.
resourceGroup	String	Não	group1	O grupo de proteção a ser consultado.
inGroup	Boolean	Não	true	Especifica se o objeto protegido foi adicionado ao grupo de proteção.
ownerUserId	String	Não	135********23	O ID da conta do Alibaba Cloud à qual o objeto protegido pertence. Você pode definir este parâmetro para realizar uma consulta exata em objetos protegidos pelo WAF que pertencem a uma conta específica em um cenário de múltiplas contas.
orderBy	String	Não	resource	O método de ordenação para objetos protegidos. Valores válidos: - resource: ordenado por nome do objeto protegido. - gmtModified: ordenado por hora de modificação.
desc	Boolean	Não	true	A ordem de classificação. Valores válidos: - false: ordem crescente. - true: ordem decrescente.

Exemplo

{
    "product ": "waf",
    "resource": "example.aliyundoc.com-waf",
    "domain": "example.aliyundoc.com",
    "resourceLike ": "example.aliyundoc.c",
    "InstaneId": "waf_cn****",
    "resourceIn": "example1.aliyundoc.com,example2.aliyundoc.com",
    "ownerUserId": "135**********41"
}
```.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
TotalCount	integer	O número total de entradas retornadas.	73
RequestId	string	O ID da solicitação.	618F2626-DB27-5187-8C6C-4E61A491****
Resources	array<object>	A lista de objetos protegidos.
	array<object>	As informações do objeto protegido.
Pattern	string	O modo de proteção do objeto protegido.	domain
Description	string	A descrição.	test
XffStatus	integer	Indica se o proxy XFF está habilitado para o objeto protegido.	1
GmtModified	integer	A hora em que o objeto protegido foi modificado pela última vez. Unidade: milissegundos.	1665633032000
Resource	string	O nome do objeto protegido.	alb-rencs***
AcwV3SecureStatus	integer	O status do atributo seguro para o cookie de controle deslizante. 0: Desabilitado. 1: Habilitado.	0
Product	string	O nome do serviço de nuvem.	alb
AcwCookieStatus	integer	O status do cookie de rastreamento. 0: Desabilitado. 1: Habilitado.	1
AcwSecureStatus	integer	O status do atributo seguro para o cookie de rastreamento. 0: Desabilitado. 1: Habilitado.	0
ResourceManagerResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
GmtCreate	integer	A hora em que o objeto protegido foi criado. Unidade: milissegundos.	1652149203187
OwnerUserId	string	A conta do Alibaba Cloud à qual o ativo do objeto protegido pertence em um cenário de recurso de gerenciamento de múltiplas contas.	135*********46
ResourceOrigin	string	A origem do objeto protegido.	custom
ResourceGroup	string	O nome do grupo de proteção ao qual o objeto protegido foi adicionado.	test
Detail	object	A descrição detalhada do objeto protegido. Diferentes pares de chave-valor no mapa representam diferentes atributos do objeto protegido.	{"domain":"eou.eleme.cn","uri":"/"}
CustomHeaders	array	Os cabeçalhos XFF personalizados usados para obter o endereço IP de origem do cliente. Se XFF estiver definido como 1 e este campo estiver vazio, o primeiro endereço IP no cabeçalho XFF será usado como o endereço IP de origem do cliente.
	string	As informações do campo de cabeçalho personalizado.	afbfbajf
ResponseHeaders	array<object>	Os parâmetros do cabeçalho de resposta.
	object	Os parâmetros do cabeçalho de resposta.
Key	string	The key of the custom response header.	Header-Key
Value	string	The value of the custom response header.	Header-Value
InstanceId	string	O ID da instância do WAF.	waf_v2_public_cn-k*****
ResourceStatus	string	O status do objeto protegido. Valores válidos: initializing: A proteção padrão está sendo inicializada. active: Em execução normal. init_failed: Falha na inicialização da proteção padrão.	active

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 73,
  "RequestId": "618F2626-DB27-5187-8C6C-4E61A491****",
  "Resources": [
    {
      "Pattern": "domain",
      "Description": "test",
      "XffStatus": 1,
      "GmtModified": 1665633032000,
      "Resource": "alb-rencs***",
      "AcwV3SecureStatus": 0,
      "Product": "alb",
      "AcwCookieStatus": 1,
      "AcwSecureStatus": 0,
      "ResourceManagerResourceGroupId": "rg-acfm***q",
      "GmtCreate": 1652149203187,
      "OwnerUserId": "135*********46",
      "ResourceOrigin": "custom",
      "ResourceGroup": "test",
      "Detail": {
        "domain": "eou.eleme.cn",
        "uri": "/"
      },
      "CustomHeaders": [
        "afbfbajf"
      ],
      "ResponseHeaders": [
        {
          "Key": "Header-Key",
          "Value": "Header-Value"
        }
      ],
      "InstanceId": "waf_v2_public_cn-k*****",
      "ResourceStatus": "active"
    }
  ]
}

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.