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

Consulta grupos de nomes de domínio.

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:DescribeDomainGroups

get

*All Resource

*

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 para o nome do grupo. A pesquisa usa o padrão %KeyWord% e não diferencia maiúsculas de minúsculas.	Group
PageNumber	integer	Não	O número da página. O valor inicial é 1. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. O valor máximo é 100. O valor padrão é 20.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DomainGroups	object
DomainGroup	array<object>	A lista de grupos de nomes de domínio.
	object
GroupId	string	The ID of the domain name group. defaultGroup: The default group. It contains domain names that are not assigned to any group. An empty string (""): Represents all domain names.	defaultGroup
GroupName	string	The name of the domain name group.	MyGroup
DomainCount	integer	The number of domain names in the group.	2
TotalCount	integer	O número total de grupos de nomes de domínio.	1
PageSize	integer	O número de entradas a serem retornadas em cada página. O valor máximo é 100. O valor padrão é 20.	20
RequestId	string	O ID exclusivo da solicitação.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	O número da página. O valor inicial é 1. O valor padrão é 1.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "DomainGroups": {
    "DomainGroup": [
      {
        "GroupId": "defaultGroup",
        "GroupName": "MyGroup",
        "DomainCount": 2
      }
    ]
  },
  "TotalCount": 1,
  "PageSize": 20,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "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.