Todos os produtos
Search
Central de documentação

Web Application Firewall:DescribeInstance

Última atualização: Aug 12, 2026

Obtém os detalhes de uma instância WAF na conta atual 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

yundun-waf:DescribeInstance

get

*Todos os recursos.

*

  • acs:ResourceGroupId
Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Não

A região onde a instância WAF está localizada. Valores válidos:

cn-hangzhou

ResourceManagerResourceGroupId

string

Não

O ID do grupo de recursos do Alibaba Cloud.

rg-acfm***q

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Status

integer

O status atual da instância. Valores válidos:

  • 1: Normal.

  • 2: Expirado.

  • 3: Liberado.

1

Details

object

Os detalhes da instância.

DefenseObjectInGroupMaxCount

integer

O número máximo de objetos de proteção que um grupo de proteção pode conter.

100

Tamperproof

boolean

Especifica se a proteção contra adulteração web é suportada. Valores válidos:

true

BotApp

string

Indica se a proteção específica de cenário contra rastreadores de aplicativos é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

IpBlacklistRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de lista negra pode conter.

100

WhitelistRuleCondition

string

Os campos de correspondência para regras de lista branca. Para mais informações, consulte a descrição do parâmetro condições de regra de lista branca (whitelist) em CreateDefenseRule.

URL

CustomRuleCondition

string

As condições de correspondência para regras personalizadas. Para mais informações, consulte a descrição do parâmetro condições de regra personalizada (custom_acl) em CreateDefenseRule.

URL

CustomResponse

boolean

Indica se respostas personalizadas são suportadas. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

HttpPorts

string

A faixa de portas HTTP disponível. Para mais informações, consulte Portas suportadas pelo WAF.

80

Gslb

boolean

Especifica se o Global Server Load Balancing (GSLB) é suportado. Valores válidos:

true

Ipv6

boolean

Especifica se o IPv6 é suportado. Valores válidos:

true

Bot

boolean

Especifica se o gerenciamento de bots é suportado. Valores válidos:

true

CustomRule

boolean

Especifica se regras personalizadas são suportadas. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

IpBlacklist

boolean

Indica se a lista negra de IPs é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

CnameResourceMaxCount

integer

O número máximo de CNAMEs que podem ser adicionados.

1000

BackendMaxCount

integer

O número máximo de endereços IP de back-to-origin que podem ser configurados.

20

ExclusiveIp

boolean

Especifica se endereços IP exclusivos são suportados. Valores válidos:

true

CustomResponseRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de resposta personalizada pode conter.

100

IpBlacklistIpInRuleMaxCount

integer

O número máximo de endereços IP que podem ser adicionados a uma regra de lista negra.

200

AclRuleMaxIpCount

integer

O número máximo de endereços IP que podem ser adicionados ao conteúdo de correspondência. Para mais informações sobre o conteúdo de correspondência, consulte Descrição da condição de correspondência.

100

BotTemplateMaxCount

integer

O número máximo de modelos de proteção de gerenciamento de bots que podem ser configurados.

50

DefenseGroupMaxCount

integer

O número máximo de grupos de proteção que podem ser configurados.

100

VastIpBlacklistInFileMaxCount

integer

O número máximo de endereços IP que podem ser importados para a lista negra de IPs em uma única importação em massa.

2000

AntiScanTemplateMaxCount

integer

O número máximo de modelos de proteção contra varredura que podem ser configurados.

20

WhitelistLogical

string

Os operadores lógicos para regras de lista branca. Para mais informações, consulte a descrição do parâmetro condições de regra de lista branca (whitelist) em CreateDefenseRule.

contain

CustomRuleTemplateMaxCount

integer

O número máximo de modelos de regras personalizadas que podem ser configurados.

20

TamperproofTemplateMaxCount

integer

O número máximo de modelos de proteção contra adulteração web que podem ser configurados.

50

IpBlacklistTemplateMaxCount

integer

O número máximo de modelos de lista negra que podem ser configurados.

20

HttpsPorts

string

A faixa de portas HTTPS disponível. Para mais informações, consulte Portas suportadas pelo WAF.

443

DlpTemplateMaxCount

integer

O número máximo de modelos de prevenção contra vazamento de informações que podem ser configurados.

50

CustomRuleRatelimitor

string

O objeto de limitação de taxa para regras personalizadas.

header

DefenseObjectMaxCount

integer

O número máximo de objetos de proteção que podem ser configurados.

20000

Dlp

boolean

Especifica se a prevenção contra vazamento de dados é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

DefenseObjectInTemplateMaxCount

integer

O número máximo de objetos de proteção que podem ser associados a um único modelo.

100

CustomRuleAction

string

As strings incluídas nas regras personalizadas.

block

TamperproofRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de proteção contra adulteração web pode conter.

50

DlpRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de prevenção contra vazamento de informações pode conter.

50

WhitelistTemplateMaxCount

integer

O número máximo de modelos de lista branca que podem ser configurados.

20

MajorProtection

boolean

Especifica se a proteção de eventos críticos é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

BaseWafGroupRuleTemplateMaxCount

integer

O número máximo de modelos de regras de proteção básica que podem ser configurados.

20

BotWeb

string

Especifica se a proteção específica de cenário contra rastreadores da web é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

CustomRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de regra personalizada pode conter.

100

VastIpBlacklistInOperationMaxCount

integer

O número máximo de endereços IP que podem ser adicionados à lista negra de IPs em uma única operação de página.

500

WhitelistRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que um único modelo de lista branca pode conter.

100

AntiScan

boolean

Especifica se a proteção contra varredura é suportada. Valores válidos:

true

CustomResponseTemplateMaxCount

integer

O número máximo de modelos de resposta personalizada que podem ser configurados.

20

BaseWafGroupRuleInTemplateMaxCount

integer

O número máximo de regras de proteção que podem ser incluídas em um único modelo de regra de proteção básica.

100

MajorProtectionTemplateMaxCount

integer

O número máximo de modelos de proteção contra eventos críticos que podem ser configurados.

20

BaseWafGroup

boolean

Especifica se as regras de proteção básica são suportadas. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

Whitelist

boolean

Especifica se a lista de permissões de IP é suportada. Valores válidos:

  • true: Suportado.

  • false: Não suportado.

true

LogService

boolean

Especifica se o serviço de logs é suportado. Valores válidos:

true

VastIpBlacklistMaxCount

integer

O número máximo de entradas na lista negra de IPs que um único usuário pode configurar.

50000

FreeQps

integer

O valor de QPS gratuito incluído no plano de assinatura. Para mais informações, consulte Edições do WAF 3.0.

Nota

Este parâmetro não tem significado prático para instâncias pay-as-you-go.

1000

ExtendQps

integer

O valor de QPS estendido da instância por assinatura. Para mais informações, consulte Edições do WAF 3.0.

Nota

Este parâmetro não se aplica a instâncias pago conforme o uso.

10000

ElasticQps

integer

O valor de QPS expansível para a instância por assinatura com cobrança pay-as-you-go para capacidade expansível. Para mais informações, consulte Edições do WAF 3.0.

Nota

Este parâmetro não tem significado prático para instâncias pay-as-you-go.

2000

QpsBillingCap

integer

O limite de proteção de cobrança de QPS para a edição pay-as-you-go. Para mais informações, consulte Proteção de cobrança de tráfego para pay-as-you-go.

Nota

Este parâmetro não tem significado prático para instâncias subscription.

2000

HybridCloud

boolean

Indica se a nuvem híbrida está ativada.

true

HybridCloudNodeExtend

integer

O número de nós estendidos de nuvem híbrida.

3

Apisec

boolean

Indica se a segurança de API está ativada.

false

AgenticApisec

boolean

Indica se a segurança de API Agentic está ativada.

true

ResourceDirectory

boolean

Indica se o recurso de gerenciamento de múltiplas contas é suportado.

true

RequestId

string

O ID da solicitação.

66A98669-CC6E-4F3E-80A6-3014697B11AE

EndTime

integer

A hora em que a instância expira. O valor é um timestamp UNIX. Unidade: milissegundos. Formato: ms.

4809859200000

InstanceId

string

O ID da instância WAF.

waf-cn-xxx

InDebt

string

Indica se a instância atual possui pagamento em atraso. Valores válidos:

1

StartTime

integer

A hora da compra. O valor é um timestamp UNIX em milissegundos.

1668496310000

RegionId

string

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

PayType

string

O método de cobrança da instância. Valores válidos:

POSTPAY

Edition

string

A edição do WAF.

default_version

ProcessStatus

string

O status de execução da instância. Valores válidos:

  • commodity_converting: A mercadoria está sendo convertida.

  • commodity_convert_check_failed: A verificação de conversão da mercadoria falhou.

  • commodity_convert_process_failed: A conversão da mercadoria falhou.

  • order_create_failed: Falha ao criar o pedido.

  • order_pending_payment: O pagamento do pedido está pendente.

order_pending_payment

Exemplos

Resposta de sucesso

JSON formato

{
  "Status": 1,
  "Details": {
    "DefenseObjectInGroupMaxCount": 100,
    "Tamperproof": true,
    "BotApp": "true",
    "IpBlacklistRuleInTemplateMaxCount": 100,
    "WhitelistRuleCondition": "URL",
    "CustomRuleCondition": "URL",
    "CustomResponse": true,
    "HttpPorts": "80",
    "Gslb": true,
    "Ipv6": true,
    "Bot": true,
    "CustomRule": true,
    "IpBlacklist": true,
    "CnameResourceMaxCount": 1000,
    "BackendMaxCount": 20,
    "ExclusiveIp": true,
    "CustomResponseRuleInTemplateMaxCount": 100,
    "IpBlacklistIpInRuleMaxCount": 200,
    "AclRuleMaxIpCount": 100,
    "BotTemplateMaxCount": 50,
    "DefenseGroupMaxCount": 100,
    "VastIpBlacklistInFileMaxCount": 2000,
    "AntiScanTemplateMaxCount": 20,
    "WhitelistLogical": "contain",
    "CustomRuleTemplateMaxCount": 20,
    "TamperproofTemplateMaxCount": 50,
    "IpBlacklistTemplateMaxCount": 20,
    "HttpsPorts": "443",
    "DlpTemplateMaxCount": 50,
    "CustomRuleRatelimitor": "header",
    "DefenseObjectMaxCount": 20000,
    "Dlp": true,
    "DefenseObjectInTemplateMaxCount": 100,
    "CustomRuleAction": "block",
    "TamperproofRuleInTemplateMaxCount": 50,
    "DlpRuleInTemplateMaxCount": 50,
    "WhitelistTemplateMaxCount": 20,
    "MajorProtection": true,
    "BaseWafGroupRuleTemplateMaxCount": 20,
    "BotWeb": "true",
    "CustomRuleInTemplateMaxCount": 100,
    "VastIpBlacklistInOperationMaxCount": 500,
    "WhitelistRuleInTemplateMaxCount": 100,
    "AntiScan": true,
    "CustomResponseTemplateMaxCount": 20,
    "BaseWafGroupRuleInTemplateMaxCount": 100,
    "MajorProtectionTemplateMaxCount": 20,
    "BaseWafGroup": true,
    "Whitelist": true,
    "LogService": true,
    "VastIpBlacklistMaxCount": 50000,
    "FreeQps": 1000,
    "ExtendQps": 10000,
    "ElasticQps": 2000,
    "QpsBillingCap": 2000,
    "HybridCloud": true,
    "HybridCloudNodeExtend": 3,
    "Apisec": false,
    "AgenticApisec": true,
    "ResourceDirectory": true
  },
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "EndTime": 4809859200000,
  "InstanceId": "waf-cn-xxx",
  "InDebt": "1",
  "StartTime": 1668496310000,
  "RegionId": "cn-hangzhou",
  "PayType": "POSTPAY",
  "Edition": "default_version",
  "ProcessStatus": "order_pending_payment"
}

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.