DescribeDcdnWafPolicies - Edge Security Acceleration - Centro de documentación de Alibaba Cloud

Consulta las políticas de mitigación configuradas de Web Application Firewall (WAF).

Descripción de la operación

Nota

Un solo usuario puede realizar hasta 20 llamadas por segundo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dcdn:DescribeDcdnWafPolicies

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
QueryArgs	string	No	La consulta condicional, que es una cadena serializada en JSON. El formato es el siguiente: `QueryArgs={"PolicyIds":"ID de política de mitigación","RuleIds":"rango de ID de regla de mitigación","PolicyNameLike":"nombre de política de mitigación","DomainNames":"nombre de dominio protegido","PolicyType":"default","DefenseScenes":"waf_group","PolicyStatus":"on","OrderBy":"GmtModified","Desc":"false"}` Nota Si no se especifica este parámetro, se consultan todas las políticas de mitigación.	{"PolicyNameLIike":"test_policy"}
PageNumber	integer	No	El número de página. Valor predeterminado: 1. Valores válidos: de 1 a 100000.	1
PageSize	integer	No	El número de políticas de mitigación que se devolverán en cada página. Valor predeterminado: 20. Valores válidos: un número entero de 1 a 500.	20

Parámetros de QueryArgs

Nombre	Tipo	Obligatorio	Ejemplo	Descripción
PolicyIds	string	No	10000001,10000002	La lista de ID de políticas de mitigación. Esta es una consulta de términos. Separe varios ID con una coma (,).
RuleIds	string	No	20000001,20000055	La lista de ID de reglas. Esta es una consulta de términos. Separe varios ID con una coma (,).
PolicyNameLike	string	No	policy_test	El nombre de la política de mitigación. Esta es una consulta difusa. El nombre puede contener caracteres chinos, letras (distingue entre mayúsculas y minúsculas), dígitos (0 a 9) y guiones bajos (_).
DomainNames	string	No	example.com	La lista de nombres de dominio protegidos. Esta es una consulta de términos. Puede especificar hasta 50 nombres de dominio. Separe varios nombres de dominio con una coma (,).
PolicyType	string	No	default	Especifica si la política es una política de mitigación predeterminada. Valores válidos: `default`: una política de mitigación predeterminada. `custom`: una política de mitigación personalizada.
DefenseScenes	string	No	custom_acl	El escenario de mitigación. Esta es una consulta de términos. Separe varios escenarios con una coma (,). Se admiten los siguientes escenarios: `waf_group`: protección web básica. `custom_acl`: políticas de mitigación personalizadas. `whitelist`: lista blanca.
PolicyStatus	string	No	on	El estado de la política. Valores válidos: `on`: habilitada. `off`: deshabilitada.
OrderBy	string	No	GmtModified	El campo por el cual ordenar los resultados. Valores válidos: `GmtModified`, `PolicyId`, `PolicyName` y `PolicyStatus`.
Desc	Boolean	No	false	El orden de clasificación. Valores válidos: `true`: descendente. `false` (predeterminado): ascendente.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageSize	integer	El número de políticas de mitigación mostradas en cada página. Valor predeterminado: 20. Valores válidos: un número entero de 1 a 500.	20
RequestId	string	El ID de la solicitud.	153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumber	integer	El número de página. Valores válidos: de 1 a 100000. Valor predeterminado: 1.	1
TotalCount	integer	El número total de políticas de mitigación.	15
Policies	array<object>	La lista de políticas de mitigación.
	object
PolicyStatus	string	El estado de la política de mitigación. El valor es el mismo que el del campo `PolicyStatus` en el parámetro de solicitud `QueryArgs`.	on
DefenseScene	string	El escenario de mitigación. El valor es el mismo que el del campo `DefenseScenes` en el parámetro de solicitud `QueryArgs`.	custom_acl
DomainCount	integer	El número de nombres de dominio que utilizan la política de mitigación.	22
PolicyName	string	El nombre de la política de mitigación.	policy_test
PolicyId	integer	El ID de la política de mitigación.	100001
RuleCount	integer	El número de reglas en la política de mitigación.	9
GmtModified	string	La hora de la última modificación de la política. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2021-12-29T17:08:45Z
PolicyType	string	Indica si la política es una política de mitigación predeterminada. El valor es el mismo que el del campo `PolicyType` en el parámetro de solicitud `QueryArgs`.	default

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-2e83-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Policies": [
    {
      "PolicyStatus": "on",
      "DefenseScene": "custom_acl",
      "DomainCount": 22,
      "PolicyName": "policy_test",
      "PolicyId": 100001,
      "RuleCount": 9,
      "GmtModified": "2021-12-29T17:08:45Z",
      "PolicyType": "default"
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.