Consulta os detalhes de um conjunto de regras do WAF para uma instância especificada.
Descrição da operação
Descrição da operação
Ao chamar a operação GetUserWafRuleset, você pode obter informações sobre um conjunto de regras específico do Web Application Firewall (WAF) com base no ID da instância e no ID do conjunto de regras. As informações retornadas incluem, mas não se limitam à posição, nome, descrição, status e regras específicas do conjunto de regras. Certifique-se de especificar corretamente os parâmetros obrigatórios para evitar falhas na solicitação.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
esa:GetUserWafRuleset |
get |
*全部资源
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceId |
string |
Sim |
O ID da instância. |
esa-xxxxxxx |
| Id |
integer |
Sim |
O ID do conjunto de regras do WAF. |
10000001 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| RequestId |
string |
O ID da solicitação. |
36af3fcc-43d0-441c-86b1-428951dc8225 |
| Ruleset |
object |
O conjunto de regras do WAF. |
{} |
| Id |
integer |
O ID do conjunto de regras do WAF. |
10000001 |
| Position |
integer |
A posição do conjunto de regras do WAF. |
1 |
| Name |
string |
O nome do conjunto de regras do WAF. |
example |
| Description |
string |
A descrição do conjunto de regras do WAF. |
example |
| Status |
string |
O status do conjunto de regras do WAF. |
on |
| Expression |
string |
A expressão do conjunto de regras do WAF. |
ip.src == 1.1.1.1 |
| Phase |
string |
A fase em que a regra do WAF é executada. Valores válidos:
|
http_custom |
| Shared | WafBatchRuleShared |
A configuração compartilhada do conjunto de regras do WAF. |
{} |
| Rules |
array<object> |
A lista de configurações de regras no conjunto de regras do WAF. |
[{}] |
|
object |
A configuração da regra no conjunto de regras do WAF. |
{} |
|
| UpdateTime |
string |
A hora da última atualização da regra WAF. |
2025-07-07T15:00:00Z |
| RulesetId |
integer |
O ID do conjunto de regras WAF. |
10000001 |
| Id |
integer |
O ID da regra WAF. |
20000001 |
| Position |
integer |
A posição da regra WAF. |
1 |
| Phase |
string |
A fase de avaliação da regra WAF. Valores válidos:
|
http_custom |
| Type |
string |
O tipo da regra WAF. |
http_ratelimit |
| Name |
string |
O nome da regra WAF. |
example |
| Status |
string |
O status da regra WAF. |
on |
| Fields |
array |
Uma lista de campos de correspondência da regra WAF. |
["ip.src"] |
|
string |
Um campo de correspondência da regra WAF. |
ip.src |
|
| CharacteristicsFields |
array |
Uma lista de campos de estatísticas da regra WAF. |
["http.host"] |
|
string |
Um campo de estatísticas da regra WAF. |
http.host |
|
| Action |
string |
A ação para a regra. Valores válidos:
|
deny |
| Skip |
string |
O modo de ignorar da regra WAF. |
all |
| Tags |
array |
As fases que a regra ignora. |
["http_custom"] |
|
string |
Uma fase que a regra ignora. |
http_custom |
|
| Config | WafRuleConfig |
A configuração da regra WAF. |
{ "Id": 20000001, "Name": "rule1", "Expression": "ip.src eq 1.1.1.1", "Action": "deny" } |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"Ruleset": {
"Id": 10000001,
"Position": 1,
"Name": "example",
"Description": "example",
"Status": "on",
"Expression": "ip.src == 1.1.1.1",
"Phase": "http_custom",
"Shared": {
"Target": "web",
"Mode": "automatic",
"CrossSiteId": 10000001,
"Name": "example",
"Match": {
"Logic": "and",
"Criteria": [
{
"Logic": "and",
"Criteria": [
{
"Logic": "and",
"Criteria": [
{
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
},
"Action": "deny",
"Actions": {
"Response": {
"Id": 50000001,
"Code": 403
}
},
"Expression": "ip.src eq 1.1.1.1"
},
"Rules": [
{
"UpdateTime": "2025-07-07T15:00:00Z",
"RulesetId": 10000001,
"Id": 20000001,
"Position": 1,
"Phase": "http_custom",
"Type": "http_ratelimit",
"Name": "example",
"Status": "on",
"Fields": [
"ip.src"
],
"CharacteristicsFields": [
"http.host"
],
"Action": "deny",
"Skip": "all",
"Tags": [
"http_custom"
],
"Config": {
"Status": "on",
"Action": "deny",
"Actions": {
"Response": {
"Id": 50000001,
"Code": 403
},
"Bypass": {
"Skip": "part",
"RegularRules": [
100001
],
"CustomRules": [
20000001
],
"RegularTypes": [
"sqli"
],
"Tags": [
"http_custom"
]
}
},
"ManagedList": "intelligence_crawler",
"ManagedRulesets": [
{
"ProtectionLevel": 4,
"Action": "deny",
"ManagedRules": [
{
"Status": "on",
"Action": "deny",
"Id": 100001
}
],
"AttackType": 11,
"NumberTotal": 100,
"NumberEnabled": 50
}
],
"Sigchl": [
"sig"
],
"Name": "example",
"AppSdk": {
"CustomSign": {
"Value": "examplesignvalue",
"Key": "sign"
},
"CustomSignStatus": "on",
"FeatureAbnormal": [
"wxbb_invalid_sign"
]
},
"RateLimit": {
"Characteristics": {
"Logic": "and",
"Criteria": [
{
"Logic": "and",
"Criteria": [
{
"Logic": "and",
"Criteria": [
{
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
}
],
"MatchType": "ip.src",
"MatchOperator": "eq",
"MatchValue": "1.1.1.1",
"Negate": false,
"ConvertToLower": false
},
"OnHit": true,
"TTL": 10,
"Threshold": {
"ManagedRulesBlocked": 10,
"DistinctManagedRules": 10,
"ResponseStatus": {
"Ratio": 10,
"Count": 10,
"Code": 404
},
"Traffic": "10Gb",
"Request": 10
},
"Interval": 10
},
"Type": "http_custom",
"AppPackage": {
"PackageSigns": [
{
"Sign": "sign",
"Name": "name"
}
]
},
"ManagedGroupId": 30000001,
"Timer": {
"Scopes": "permanent",
"Zone": 8,
"Periods": [
{
"Start": "2025-01-01T00:00:00Z",
"End": "2025-01-01T01:00:00Z"
}
],
"WeeklyPeriods": [
{
"Days": "1",
"DailyPeriods": [
{
"Start": "00:00:00",
"End": "01:00:00"
}
]
}
]
},
"Expression": "ip.src eq 10.0.0.1",
"SecurityLevel": {
"Value": "low"
},
"Value": "10.0.0.1",
"Id": 20000001,
"Notes": "example notes"
}
}
]
}
}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. | Falha na validação do formato do parâmetro de entrada. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | A chamada do serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte ao cliente para obter detalhes. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.