DescribeDomains - Alibaba Cloud DNS: Central de Documentação do Alibaba Cloud

Consulta a lista de nomes de domínio do usuário com base nos parâmetros de consulta.

Descrição da operação

Você pode especificar o número da página (PageNumber) e o número de entradas por página (PageSize) para recuperar a lista de nomes de domínio.
Você pode especificar uma palavra-chave (KeyWord) para consultar nomes de domínio que contenham a palavra-chave.
Por padrão, a lista de nomes de domínio é classificada em ordem decrescente de acordo com a hora em que os nomes de domínio foram adicionados.
Você pode especificar um ID de grupo de nomes de domínio (GroupId). All Domains representa todos os nomes de domínio, e Default Group representa os nomes de domínio que não estão atribuídos a nenhum grupo.

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

alidns:DescribeDomains

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang	string	Não	O idioma da resposta. Valores válidos: zh: chinês. en: inglês. Valor padrão: zh.	en
KeyWord	string	Não	A palavra-chave. A pesquisa é realizada no formato "%KeyWord%" e não diferencia maiúsculas de minúsculas.	com
GroupId	string	Não	O ID do grupo de nomes de domínio. Se você não especificar este parâmetro ou especificar uma string vazia, a consulta será realizada em All Domains. Se você especificar defaultGroup, a consulta será realizada em Default Group.	defaultGroup
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	As configurações do número de entradas por página para paginação em uma consulta paginada. Valor máximo: 100. Valor padrão: 20.	20
SearchMode	string	Não	O modo de pesquisa. Valores válidos: LIKE: pesquisa aproximada. EXACT: pesquisa exata. Valor padrão: LIKE.	LIKE
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-re********
Starmark	boolean	Não	Especifica se devem ser consultados os nomes de domínio marcados com estrela. Valores válidos: true: sim. false: não. Valor padrão: true.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Domains	object
Domain	array<object>	A lista de nomes de domínio retornada na resposta atual.
	array<object>	A lista de nomes de domínio retornada na resposta atual.
Remark	string	A observação.	remark
CreateTime	string	A hora em que o nome de domínio foi adicionado. A hora é exibida em UTC e formatada como YYYY-MM-DDTHH:mmZ.	2019-01-30T05:25Z
RecordCount	integer	O número de registros DNS do nome de domínio.	100
Tags	object
Tag	array<object>	A matriz de pares chave-valor de tag.
	object
Key	string	A chave da tag.	Test tag
Value	string	O valor da tag.	Test tag value
InstanceId	string	O ID da instância do Alibaba Cloud DNS.	i-***
DomainName	string	O nome de domínio.	example.com
DomainId	string	O ID do nome de domínio.	00efd71a-770e-4255-*********
AliDomain	boolean	Indica se o nome de domínio é um nome de domínio do Alibaba Cloud.	true
GroupId	string	O ID do grupo de nomes de domínio.	2***
GroupName	string	O nome do grupo de nomes de domínio.	mygroup
ResourceGroupId	string	O ID do grupo de recursos ao qual o nome de domínio pertence.	rg***
InstanceEndTime	string	A hora de expiração da instância. A hora é exibida em UTC e formatada como YYYY-MM-DDTHH:mmZ.	2020-03-14T16:00Z
InstanceExpired	boolean	Indica se a instância expirou.	false
VersionName	string	A edição do Alibaba Cloud DNS.	Enterprise Ultimate Edition
DnsServers	object
DnsServer	array	A lista de nomes de servidores DNS atribuídos pelo Alibaba Cloud DNS.
	string	O nome do servidor DNS atribuído pelo Alibaba Cloud DNS.	{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}
VersionCode	string	O código da edição do Alibaba Cloud DNS.	version_enterprise_basic
PunyCode	string	O Punycode do nome de domínio em chinês. Este parâmetro está vazio para nomes de domínio em inglês.	example.com
RegistrantEmail	string	O endereço de e-mail do registrante.	****@example.com
CreateTimestamp	integer	O timestamp em que o nome de domínio foi adicionado.	1660546144000
Starmark	boolean	Indica se o nome de domínio está marcado com estrela.	true
DomainLoggingSwitchStatus	string	O status de ativação da análise de tráfego de rede DNS para o nome de domínio. Valores válidos: OPEN: ativado. CLOSE: desativado.	OPEN
SlaveDnsStatus	string
TotalCount	integer	O número total de nomes de domínio.	2
PageSize	integer	As configurações do número de entradas por página para paginação em uma consulta paginada. Valor máximo: 100. Valor padrão: 20.	2
RequestId	string	O ID da solicitação.	68386699-8B9E-4D5B-BC4C-75A28F6C2A00
PageNumber	integer	O número da página. As páginas começam na página 1. Valor padrão: 1.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "Domains": {
    "Domain": [
      {
        "Remark": "remark",
        "CreateTime": "2019-01-30T05:25Z",
        "RecordCount": 100,
        "Tags": {
          "Tag": [
            {
              "Key": "测试标签",
              "Value": "测试标签值"
            }
          ]
        },
        "InstanceId": "i-***",
        "DomainName": "example.com\n",
        "DomainId": "00efd71a-770e-4255-*********",
        "AliDomain": true,
        "GroupId": "2***",
        "GroupName": "mygroup",
        "ResourceGroupId": "rg***",
        "InstanceEndTime": "2020-03-14T16:00Z",
        "InstanceExpired": false,
        "VersionName": "企业旗舰版",
        "DnsServers": {
          "DnsServer": [
            "{\"DnsServer\": [\"ns1.alidns.com\",\"ns2.alidns.com\"]}"
          ]
        },
        "VersionCode": "version_enterprise_basic",
        "PunyCode": "example.com\n",
        "RegistrantEmail": "****@example.com",
        "CreateTimestamp": 1660546144000,
        "Starmark": true,
        "DomainLoggingSwitchStatus": "OPEN",
        "SlaveDnsStatus": ""
      }
    ]
  },
  "TotalCount": 2,
  "PageSize": 2,
  "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
  "PageNumber": 1
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.