DescribeDomains - Web Application Firewall - Centro de documentación de Alibaba Cloud

Consulta los nombres de dominio agregados a Web Application Firewall (WAF).

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

yundun-waf:DescribeDomains

get

*DefenseResource

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

Ninguna

yundun-waf:DescribeDomains

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia de WAF. Nota Llame a DescribeInstance para ver el ID de la instancia de WAF actual.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	El ID del grupo de recursos de Alibaba Cloud.	rg-acfm***q
Domain	string	No	El nombre de dominio agregado a WAF.	www.aliyundoc.com
Backend	string	No	La dirección IP del servidor de origen o el nombre de dominio de retorno al origen. Solo puede especificar una de estas opciones.	1.1.XX.XX
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	10
DomainId	string	No	El ID del nombre de dominio.	www.aliyundoc.com-waf
RegionId	string	No	La región donde reside la instancia de WAF. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fuera de China continental.	cn-hangzhou
Tag	array<object>	No	Las etiquetas del recurso. Se admite un máximo de 20 etiquetas.
	object	No	Las etiquetas del recurso.
Key	string	No	La clave de la etiqueta.	TagKey1
Value	string	No	El valor de la etiqueta.	TagValue1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La lista de nombres de dominio agregados.
RequestId	string	El ID de la solicitud.	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	El número total de configuraciones de nombres de dominio devueltas.	146
Domains	array<object>	La lista de nombres de dominio.
	array<object>	Los detalles de conexión CNAME.
Domain	string	El nombre de dominio que está agregado a WAF.	www.aliyundoc.com
Status	integer	El estado del nombre de dominio. Valores válidos: 1: El nombre de dominio se encuentra en estado normal. 2: El nombre de dominio se está creando. 3: El nombre de dominio se está modificando. 4: El nombre de dominio se está liberando. 5: El reenvío está deshabilitado para el nombre de dominio.	1
Cname	string	El nombre canónico (CNAME) asignado al nombre de dominio por WAF.	xxxxxcvdaf.****.com
ListenPorts	object	La configuración del listener.
Http	array	La lista de puertos de escucha para el protocolo HTTP.
	integer	El puerto de escucha para el protocolo HTTP.	80
Https	array	La lista de puertos de escucha para el protocolo HTTPS.
	integer	El puerto de escucha para el protocolo HTTPS.	443
Backeds	object	La configuración de retorno al origen.
Http	array<object>	La lista de direcciones de origen para el protocolo HTTP.
	object	La dirección de origen para el protocolo HTTP.
Backend	string	La dirección de origen para el protocolo HTTP.	1.1.XX.XX
Https	array<object>	La lista de direcciones de origen para el protocolo HTTPS.
	object	La dirección de origen para el protocolo HTTPS.
Backend	string	La dirección de origen para el protocolo HTTPS.	1.1.XX.XX
ResourceManagerResourceGroupId	string	El ID del grupo de recursos de Alibaba Cloud.	rg-acfmvtc5z52****
DomainId	string	El ID del nombre de dominio.	www.aliyundoc.com-waf

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	The domain name and domain name ID cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	The input parameters Domain and DomainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	Illegal entry DomainId

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.