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

Consulta um único objeto protegido.

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:DescribeDefenseResource

get

*DefenseResource

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	O ID da instância do WAF. null Você pode chamar a operação de API DescribeInstance para consultar o ID da instância atual do WAF.	waf_v3prepaid_public_cn-4xl****i60i
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
Resource	string	Sim	O nome do objeto protegido a ser consultado. Você pode definir este parâmetro para consultar com precisão um objeto protegido que foi adicionado ao WAF.	example.aliyundoc.com-waf
RegionId	string	Não	A região onde a instância do WAF está localizada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
RequestId	string	O ID da solicitação.	439AADF2-368C-5E98-B14E-3086****0573
Resource	object	As informações sobre o objeto protegido.
GmtCreate	integer	A hora em que o objeto protegido foi criado. Unidade: milissegundos.	1607493144000
GmtModified	integer	A hora em que o objeto protegido foi modificado. Unidade: milissegundos.	1691720010000
Product	string	O nome do serviço de nuvem.	alb
Resource	string	O nome do objeto protegido.	alb-rencs***
ResourceGroup	string	O nome do grupo de objetos protegidos ao qual o objeto protegido foi adicionado.	example_resource_group
Detail	object	A descrição detalhada do objeto protegido. Diferentes pares chave-valor no Map representam diferentes atributos do objeto protegido.	{ "product": "waf", "domain": "demo.aliyundoc****.com" }
Pattern	string	O modo de proteção do objeto protegido.	domain
XffStatus	integer	Indica se um proxy da camada 7 (Anti-DDoS/CDN, etc.) está implantado na frente do WAF. Valores válidos: 0: não ativado. 1: ativado.	0
CustomHeaders	array	A lista de campos de cabeçalho especificados. null Quando XffStatus é definido como 1, o primeiro endereço IP no campo de cabeçalho especificado é usado como o endereço IP de origem do cliente para evitar falsificação de XFF. Se vários campos de cabeçalho forem especificados, eles serão testados em ordem para obter o endereço IP de origem. Se o endereço IP de origem não puder ser obtido do primeiro campo de cabeçalho, o segundo campo de cabeçalho será testado, e assim por diante. Se o endereço IP de origem não puder ser obtido de nenhum dos campos de cabeçalho especificados, o primeiro endereço IP em X-Forwarded-For será usado. Quando XffStatus é definido como 1, indica que o endereço IP de origem é obtido do primeiro campo de cabeçalho.
	string	O campo de cabeçalho especificado.	x-forwarded-for
ResourceOrigin	string	A origem do objeto protegido. Valores válidos: custom: o objeto protegido criado a partir do Access Management. access: o objeto protegido criado pelo usuário.	custom
Description	string	A descrição.	This is Description
ResourceManagerResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud.	rg-acfmoiy****p2oq
AcwCookieStatus	integer	O status do cookie de rastreamento. Valores válidos: 0: desativado. 1: ativado.	0
AcwSecureStatus	integer	O status do atributo seguro do cookie de rastreamento. Valores válidos: 0: desativado. 1: ativado.	0
AcwV3SecureStatus	integer	O status do atributo seguro do cookie do controle deslizante. Valores válidos: 0: desativado. 1: ativado.	0
OwnerUserId	string	O UID do proprietário do objeto protegido.	170457******9107
ResponseHeaders	array<object>	Os parâmetros do cabeçalho de resposta.
	object	O parâmetro do cabeçalho de resposta.
Key	string	The key of the specified custom response header.	Header-Key
Value	string	The value of the specified custom response header.	Header-Value
InstanceId	string	O ID da instância do WAF.	waf_v2_public_cn-wwo****
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

{
  "RequestId": "439AADF2-368C-5E98-B14E-3086****0573",
  "Resource": {
    "GmtCreate": 1607493144000,
    "GmtModified": 1691720010000,
    "Product": "alb",
    "Resource": "alb-rencs***\n",
    "ResourceGroup": "example_resource_group",
    "Detail": {
      "product": "waf",
      "domain": "demo.aliyundoc****.com"
    },
    "Pattern": "domain",
    "XffStatus": 0,
    "CustomHeaders": [
      "x-forwarded-for"
    ],
    "ResourceOrigin": "custom",
    "Description": "This is Description",
    "ResourceManagerResourceGroupId": "rg-acfmoiy****p2oq",
    "AcwCookieStatus": 0,
    "AcwSecureStatus": 0,
    "AcwV3SecureStatus": 0,
    "OwnerUserId": "170457******9107",
    "ResponseHeaders": [
      {
        "Key": "Header-Key\n",
        "Value": "Header-Value\n"
      }
    ],
    "InstanceId": "waf_v2_public_cn-wwo****",
    "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.