Consulta de conjuntos de registros em uma zona
Função
Consulta de conjuntos de registros em uma zona
Depuração
Você pode depurar esta API por meio da autenticação automática no API Explorer ou usar o código de exemplo do SDK gerado pelo API Explorer.
URI
GET /v2.1/zones/{zone_id}/recordsets
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
zone_id |
Sim |
String |
ID da zona |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
marker |
Não |
String |
Iniciar o ID do recurso da consulta de paginação. Se o parâmetro for deixado em branco, somente os recursos na primeira página serão consultados. É 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. |
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. |
line_id |
Não |
String |
ID da linha de resolução |
tags |
Não |
String |
Tag de recurso. O formato é o seguinte: chave1,valor1|chave2,valor2. Várias tags são separadas por barra vertical (|). A chave e o valor de cada tag são separados por vírgula (,). |
status |
Não |
String |
Status dos conjuntos de registros a serem consultados. O valor pode ser ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE ou PENDING_DELETE. |
type |
Não |
String |
Tipo de conjunto de registros. O valor pode ser A, CNAME, MX, AAAA, TXT, SRV, NS ou CAA. |
name |
Não |
String |
Nome do conjunto de registros a ser consultado. Correspondência difusa funcionará. É deixado em branco por padrão. |
id |
Não |
String |
ID do conjunto de registros a ser consultado. Correspondência difusa funcionará. É deixado em branco por padrão. |
sort_key |
Não |
String |
Campo de classificação dos conjuntos de registros na lista. Opções de valor:
O valor padrão é deixado em branco, indicando que os conjuntos de registros não são classificados. |
sort_dir |
Não |
String |
Ordem de classificação dos conjuntos de registros na lista. Opções de valor:
O valor padrão é deixado em branco, indicando que os conjuntos de registros não são classificados. |
search_mode |
Não |
String |
Modo de pesquisa. Opções de valor:
|
Parâmetros 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
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. |
recordsets |
Array of ShowRecordSetByZoneResp objects |
Lista de conjuntos de registros |
metadata |
metadata object |
Número de recursos que atendem à condição de consulta |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do conjunto de registros |
name |
String |
Nome do conjunto de registros |
description |
String |
Descrição do conjunto de registros |
zone_id |
String |
ID da zona do conjunto de registros |
zone_name |
String |
Nome da zona do conjunto de registros |
type |
String |
Tipo de conjunto de registros. O valor pode ser A, AAAA, MX, CNAME, TXT, NS, SRV ou CAA. |
ttl |
Integer |
Duração do armazenamento em cache do conjunto de registros (em segundos) em um servidor do DNS local. Quanto maior a duração, mais lenta a atualização terá efeito. |
records |
Array of strings |
Valor do conjunto de registos |
create_at |
String |
Tempo de criação |
update_at |
String |
Hora da atualização |
status |
String |
Status do recurso |
default |
Boolean |
Se o conjunto de registros é criado por padrão. Um conjunto de registros padrão não pode ser excluído. |
project_id |
String |
ID do projeto do conjunto de registros |
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. |
line |
String |
ID da linha de resolução |
weight |
Integer |
Peso do conjunto de recordes |
health_check_id |
String |
ID de verificação de integridade |
alias_target |
alias_target object |
Alias de nome de domínio |
Parâmetro |
Tipo |
Descrição |
---|---|---|
self |
String |
Link para o recurso atual |
next |
String |
Link para a próxima página |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
Esta API é usada para consultar conjuntos de registros em uma zona.
{ "links" : { "self" : "https://Endpoint/v2.1/recordsets?limit=1&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149", "next" : "https://Endpoint/v2.1/recordsets?limit=11&marker=2c9eb155587194ec01587224c9f9014a&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149" }, "recordsets" : [ { "id" : "2c9eb155587194ec01587224c9f9014a", "name" : "example.com.", "type" : "SOA", "ttl" : 300, "records" : [ "ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)" ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "id" : "2c9eb155587194ec01587224c9f9014c", "name" : "example.com.", "type" : "NS", "ttl" : 172800, "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T11:56:03.439", "update_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.2", "192.168.10.1" ], "status" : "PENDING_CREATE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "create_at" : "2016-11-17T12:03:17.827", "update_at" : "2016-11-17T12:56:06.439", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null } ], "metadata" : { "total_count" : 3 } }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Esta API é usada para consultar conjuntos de registros em uma zona. |
Códigos de erro
Consulte Códigos de erro.