Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Domain Name Service/ Referência de API/ APIs/ Gerenciamento de zonas públicas/ Consulta de zonas públicas

Atualizado em 2025-08-19 GMT+08:00

Ver PDF

Consulta de zonas públicas

Função

Depuração

Você pode depurar esta API por meio da autenticação automática no Chamada das API ou usar o código de exemplo do SDK gerado pelo API Explorer.

URI

GET /v2/zones

**Tabela 1** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
type	Não	String	Tipo de zona. O valor pode ser public ou private. Se este parâmetro for deixado em branco, as zonas públicas serão consultadas. Se o valor for public, as zonas públicas serão consultadas. Se o valor for private, as zonas privadas serão consultadas. Correspondência difusa funcionará. Este parâmetro é deixado em branco por padrão.
limit	Não	Integer	Número de recursos em cada página. O valor varia de 0 a 500. Os valores comumente usados são 10, 20 e 50. O valor padrão é 500.
marker	Não	String	Inicie o ID do recurso no início da consulta de paginação. Se o parâmetro for deixado em branco, somente os recursos na primeira página serão consultados. Este parâmetro é deixado vazio por padrão.
offset	Não	Integer	Iniciar deslocamento da consulta de paginação. A consulta começará a partir do próximo recurso do valor deslocamento. O valor varia de 0 a 2147483647. O valor padrão é 0. Se o marker não for deixado em branco, a consulta será iniciada a partir do recurso especificado pelo marker.
tags	Não	String	Tag de recurso. O formato é o seguinte: chave1,valor1\|chave2,valor2. Múltiplas tags são separadas por barra vertical (\|). A chave e o valor de cada tag são separados por vírgula (,). As tags estão no relacionamento AND. Para obter detalhes sobre tags de recurso, consulte Adição de tags de recurso. A correspondência exata funcionará. Se o valor começa com um asterisco (*), a correspondência difusa funcionará para a cadeia após o asterisco. Este parâmetro é deixado em branco por padrão.
name	Não	String	Nome da zona
status	Não	String	Status do recurso
enterprise_project_id	Não	String	ID do projeto corporativo associado à zona. O valor contém no máximo 36 caracteres. Valor padrão: 0.

Parâmetros de solicitação

**Tabela 2** Parâmetros do cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Ele pode ser obtido pela chamada de uma API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário.

Parâmetros de resposta

Código de status: 200

**Tabela 3** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
links	pageLink object	Link do recurso atual ou outros recursos relacionados. Quando uma resposta é dividida em páginas, um próximo link é fornecido para recuperar todos os resultados.
zones	Array of PublicZoneResp objects	Resposta à solicitação de consulta de zonas públicas
metadata	metadata object	Número de recursos que atendem à condição de consulta

**Tabela 4** PublicZoneResp
Parâmetro	Tipo	Descrição
id	String	ID da zona, um UUID usado para identificar a zona
name	String	Nome da zona
description	String	Descrição da zona
email	String	Endereço de e-mail do administrador que gerencia a zona
zone_type	String	Tipo de zona. O valor pode ser public ou private.
ttl	Integer	Valor TTL do conjunto de registros SOA na zona
serial	Integer	Número de sequência usado para identificar alterações no arquivo de zona no conjunto de registros SOA da zona. O número de sequência é usado para sincronização entre os nós mestre e subordinado.
status	String	Status do recurso
record_num	Integer	Número de conjuntos de registros na zona
pool_id	String	ID do pool da zona, atribuído pelo sistema
project_id	String	ID do projeto da zona
created_at	String	Tempo de criação
updated_at	String	Hora da atualização
links	pageLink object	Link do recurso atual ou outros recursos relacionados. Quando uma resposta é dividida em páginas, um próximo link é fornecido para recuperar todos os resultados.
tags	Array of tag objects	Tag de recurso
masters	Array of strings	Servidores mestres DNS, dos quais os servidores subordinados obtêm informações do DNS.
enterprise_project_id	String	ID do projeto corporativo associado à zona. O valor contém no máximo 36 caracteres.

**Tabela 5** pageLink
Parâmetro	Tipo	Descrição
self	String	Link para o recurso atual
next	String	Link para a próxima página

**Tabela 6** tag
Parâmetro	Tipo	Descrição
key	String	Chave da tag. Uma chave pode conter até 36 caracteres Unicode. Não pode ser deixada em branco. Um valor de tag não pode conter caracteres especiais (=*<>,\|/) nem iniciar ou terminar com espaços.
value	String	Valor da tag. Um valor de tag contém no máximo 43 caracteres Unicode e pode ser deixado em branco. Um valor de tag não pode conter caracteres especiais (=*<>,\|/) nem iniciar ou terminar com espaços.

**Tabela 7** metadata
Parâmetro	Tipo	Descrição
total_count	Integer	Número de recursos que atendem aos critérios de filtro. O número é irrelevante para limit ou offset.

Código de status: 400

**Tabela 8** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
code	String	Código de erro Mínimo: 8 Máximo: 36
message	String	Descrição Mínimo: 2 Máximo: 512

Código de status: 404

**Tabela 9** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
code	String	Código de erro Mínimo: 8 Máximo: 36
message	String	Descrição Mínimo: 2 Máximo: 512

Código de status: 500

**Tabela 10** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
code	String	Código de erro Mínimo: 8 Máximo: 36
message	String	Descrição Mínimo: 2 Máximo: 512

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

Resposta à solicitação de consulta de zonas públicas

{
  "links" : {
    "self" : "https://Endpoint/v2/zones?type=public&limit=11",
    "next" : "https://Endpoint/v2/zones?type=public&limit=11&marker=2c9eb155587194ec01587224c9f90149"
  },
  "zones" : [ {
    "id" : "2c9eb155587194ec01587224c9f90149",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
    },
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_at" : "2016-11-17T11:56:05.528",
    "record_num" : 2
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "PENDING_CREATE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    },
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:01:18.528",
    "record_num" : 2
  } ],
  "metadata" : {
    "total_count" : 2
  }
}