DescribeUserDomains - CDN: Central de Documentação do Alibaba Cloud

Consulta todos os nomes de domínio acelerados na sua conta Alibaba Cloud e o status desses nomes de domínio. Você pode filtrar os nomes de domínio por nome ou status. Há suporte para correspondência aproximada.

Descrição da operação

Cada conta pode chamar esta operação até 100 vezes por segundo.
Você pode especificar até 50 nomes de domínio em cada solicitação. Separe vários nomes de domínio com vírgulas (,).

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

cdn:DescribeUserDomains

get

*Domain

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 500. Valor padrão: 20. Valor máximo: 500.	5
PageNumber	integer	Não	O número da página. Valores válidos: 1 a 100000.	1
DomainName	string	Não	O domínio acelerado. Se você não definir este parâmetro, todos os nomes de domínio que correspondem às condições serão retornados.	example.com
DomainStatus	string	Não	O status do nome de domínio. Valores válidos: online offline configuring configure_failed checking check_failed stopping deleting Se você não definir este parâmetro, os nomes de domínio em todos os estados serão consultados.	configure_failed
DomainSearchType	string	Não	O modo de pesquisa. Valores válidos: fuzzy_match: correspondência aproximada pre_match: correspondência de prefixo suf_match: correspondência de sufixo full_match (padrão): correspondência exata Nota Se você especificar os nomes de domínio a serem consultados, mas não definir o parâmetro DomainSearchType, o modo de correspondência exata será usado.	fuzzy_match
CdnType	string	Não	O tipo de carga de trabalho acelerada pelo Alibaba Cloud CDN. Separe os tipos com vírgulas (,). Valores válidos: web: imagens e arquivos pequenos download: arquivos grandes video: streaming de vídeo e áudio sob demanda Se você não definir este parâmetro, todos os tipos de serviço serão consultados.	download,web,video
CheckDomainShow	boolean	Não	Especifica se devem ser exibidos os nomes de domínio que estão em análise, falharam na análise ou falharam ao serem configurados. Valores válidos: true false	false
ResourceGroupId	string	Não	O ID do grupo de recursos. Por padrão, todos os IDs são consultados.	abcd1234abcd1234
ChangeStartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.	2019-10-10T12:14:55Z
ChangeEndTime	string	Não	O fim do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota O horário de término deve ser posterior ao horário de início.	2019-10-10T12:14:58Z
Coverage	string	Não	A região de aceleração. Por padrão, todas as regiões de aceleração são consultadas. Valores válidos: domestic: China continental global: global overseas: fora da China continental	domestic
Source	string	Não	As informações sobre o servidor de origem.	***
Tag	array<object>	Não	A lista de tags. Número máximo de elementos na lista: 20.
	object	Não	Os detalhes sobre as tags.
Key	string	Não	A chave de uma tag. Por padrão, todas as chaves de tag são consultadas.	key
Value	string	Não	O valor da tag. Por padrão, todos os valores de tag são consultados.	value

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A descrição dos dados retornados.
RequestId	string	O ID da solicitação.	BDA62CE4-3477-439A-B52E-D2D7C829D7C1
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	20
TotalCount	integer	O número total de entradas retornadas.	2
Domains	object
PageData	array<object>	A lista dos nomes de domínio acelerados retornados.
	array<object>	As informações sobre o nome de domínio acelerado.
SslProtocol	string	Indicates whether HTTPS is enabled. Valid values: on off	on
Sandbox	string	Indicates whether the accelerated domain name is in a sandbox.	true
GmtModified	string	The time when the accelerated domain name was modified.	2015-10-28T11:05:52Z
DomainName	string	The accelerated domain.	example.com
DomainId	integer	The ID of the accelerated domain name.	11223344
GmtCreated	string	The time when the accelerated domain name was added.	2015-10-28T09:32:51Z
Description	string	The information about Internet Content Provider (ICP) filing.	filing description
Coverage	string	The acceleration region. Valid values: domestic: Chinese mainland global: global overseas: outside the Chinese mainland	domestic
ResourceGroupId	string	The ID of the resource group.	abcd1234abcd1234
Cname	string	The CNAME assigned to the accelerated domain name.	example.com.w.alikunlun.net
DomainStatus	string	The status of the accelerated domain name. Valid values: online offline configuring configure_failed checking check_failed stopping deleting	configure_failed
CdnType	string	The type of the workload accelerated by Alibaba Cloud CDN. Valid values: web: images and small files download: large files video: on-demand video and audio streaming	download
Sources	object
Source	array<object>	The information about the origin server.
	object	The details about the origin server.
Type	string	The type of the origin server.	oss
Weight	string	The weight of the origin server if multiple origin servers have been specified.	15
Priority	string	The priority.	20
Port	integer	The port of the origin server.	80
Content	string	The address of the origin server.	***.oss-cn-hangzhou.aliyuncs.com

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.