DescribeUserDomains - CDN - Centro de documentación de Alibaba Cloud

Consulta todos los nombres de dominio acelerados en su cuenta de Alibaba Cloud y el estado de dichos nombres de dominio. Puede filtrar los nombres de dominio por nombre o estado. Se admite la coincidencia aproximada.

Descripción de la operación

Cada cuenta puede invocar esta operación hasta 100 veces por segundo.
Puede especificar hasta 50 nombres de dominio en cada solicitud. Separe varios nombres de dominio con comas (,).

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

cdn:DescribeUserDomains

get

*Domain

acs:cdn:*:{#accountId}:domain/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: 1 a 500. Valor predeterminado: 20. Valor máximo: 500.	5
PageNumber	integer	No	El número de página. Valores válidos: 1 a 100000.	1
DomainName	string	No	El dominio acelerado. Si no establece este parámetro, se devuelven todos los nombres de dominio que coinciden con las condiciones.	example.com
DomainStatus	string	No	El estado del nombre de dominio. Valores válidos: online offline configuring configure_failed checking check_failed stopping deleting Si no establece este parámetro, se consultan los nombres de dominio en todos los estados.	configure_failed
DomainSearchType	string	No	El modo de búsqueda. Valores válidos: fuzzy_match: coincidencia aproximada pre_match: coincidencia de prefijo suf_match: coincidencia de sufijo full_match (predeterminado): coincidencia exacta Nota Si especifica los nombres de dominio a consultar pero no establece el parámetro DomainSearchType, se utiliza el modo de coincidencia exacta.	fuzzy_match
CdnType	string	No	El tipo de carga de trabajo acelerada por Alibaba Cloud CDN. Separe los tipos con comas (,). Valores válidos: web: imágenes y archivos pequeños download: archivos grandes video: transmisión de video y audio bajo demanda Si no establece este parámetro, se consultan todos los tipos de servicio.	download,web,video
CheckDomainShow	boolean	No	Especifica si se deben mostrar los nombres de dominio que están en revisión, que no superaron la revisión o cuya configuración falló. Valores válidos: true false	false
ResourceGroupId	string	No	El ID del grupo de recursos. De forma predeterminada, se consultan todos los ID.	abcd1234abcd1234
ChangeStartTime	string	No	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.	2019-10-10T12:14:55Z
ChangeEndTime	string	No	El final del intervalo de tiempo a consultar. Especifique la hora en formato yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Nota La hora de finalización debe ser posterior a la hora de inicio.	2019-10-10T12:14:58Z
Coverage	string	No	La región de aceleración. De forma predeterminada, se consultan todas las regiones de aceleración. Valores válidos: domestic: China continental global: global overseas: fuera de China continental	domestic
Source	string	No	La información sobre el servidor de origen.	example.source.com
Tag	array<object>	No	La lista de etiquetas. Número máximo de elementos en la lista: 20
	object	No	Los detalles de las etiquetas.
Key	string	No	La clave de una etiqueta. De forma predeterminada, se consultan todas las claves de etiqueta.	key
Value	string	No	El valor de la etiqueta. De forma predeterminada, se consultan todos los valores de etiqueta.	value

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La descripción de los datos devueltos.
RequestId	string	El ID de la solicitud.	BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumber	integer	El número de la página devuelta.	1
PageSize	integer	El número de entradas devueltas por página.	20
TotalCount	integer	El número total de entradas devueltas.	2
Domains	object
PageData	array<object>	La lista de nombres de dominio acelerados devueltos.
	array<object>	La información sobre el nombre de dominio acelerado.
SslProtocol	string	Indica si HTTPS está habilitado. Valores válidos: on off	on
Sandbox	string	Indica si el nombre de dominio acelerado se encuentra en un entorno aislado (sandbox).	true
GmtModified	string	La hora en que se modificó el nombre de dominio acelerado.	2015-10-28T11:05:52Z
DomainName	string	El dominio acelerado.	example.com
DomainId	integer	El ID del nombre de dominio acelerado.	11223344
GmtCreated	string	La hora en que se agregó el nombre de dominio acelerado.	2015-10-28T09:32:51Z
Description	string	La información sobre el registro ICP (Proveedor de Contenido de Internet).	filing description
Coverage	string	La región de aceleración. Valores válidos: domestic: China continental global: global overseas: fuera de China continental	domestic
ResourceGroupId	string	El ID del grupo de recursos.	abcd1234abcd1234
Cname	string	El CNAME asignado al nombre de dominio acelerado.	example.com.w.alikunlun.net
DomainStatus	string	El estado del nombre de dominio acelerado. Valores válidos: online offline configuring configure_failed checking check_failed stopping deleting	configure_failed
CdnType	string	El tipo de carga de trabajo acelerada por Alibaba Cloud CDN. Valores válidos: web: imágenes y archivos pequeños download: archivos grandes video: transmisión de video y audio bajo demanda	download
Sources	object
Source	array<object>	La información sobre el servidor de origen.
	object	Los detalles sobre el servidor de origen.
Type	string	El tipo de servidor de origen.	oss
Weight	string	El peso del servidor de origen si se han especificado varios servidores de origen.	15
Priority	string	La prioridad.	20
Port	integer	El puerto del servidor de origen.	80
Content	string	La dirección del servidor de origen.	***.oss-cn-hangzhou.aliyuncs.com

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "SslProtocol": "on",
        "Sandbox": "true",
        "GmtModified": "2015-10-28T11:05:52Z",
        "DomainName": "example.com",
        "DomainId": 11223344,
        "GmtCreated": "2015-10-28T09:32:51Z",
        "Description": "filing description",
        "Coverage": "domestic",
        "ResourceGroupId": "abcd1234abcd1234",
        "Cname": "example.com.w.alikunlun.net",
        "DomainStatus": "configure_failed",
        "CdnType": "download",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Weight": "15",
              "Priority": "20",
              "Port": 80,
              "Content": "***.oss-cn-hangzhou.aliyuncs.com"
            }
          ]
        }
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.
400	InvalidChangeStartTime.Malformed	The specified ChangeStartTime is invalid.
400	InvalidChangeEndTime.Malformed	The specified ChangeEndTime is invalid.
400	InvalidCdnType.Malformed	The specified CdnType is invalid.

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.