Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2024-09-14 GMT+08:00

Consulta de conjuntos de registros

Función

Esta API se utiliza para consultar conjuntos de registros.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

GET /v2/recordsets

Tabla 1 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

zone_type

No

String

Tipo de zona del conjunto de registros que se va a consultar. El valor puede ser public o private.

  • public (predeterminado): Se consultan conjuntos de registros de zonas públicas.

  • private: Se consultan conjuntos de registros de zonas privadas.

La búsqueda difusa funcionará.

Si el valor se deja en blanco, los conjuntos de registros de las zonas públicas se consultan de forma predeterminada.

marker

No

String

Iniciar ID de recurso de consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página. Se deja en blanco por defecto.

search_mode

No

String

Modo de búsqueda.

Las opciones son las siguientes:

  • like: búsqueda difusa

  • equal: búsqueda exacta

limit

No

Integer

Número de recursos en cada página. El valor oscila entre 0 y 500. Los valores utilizados comúnmente son 10, 20 y 50. El valor predeterminado es 500.

offset

No

Integer

Comenzar el desplazamiento de la consulta de paginación. La consulta comenzará a partir del siguiente recurso del valor de desplazamiento.

El valor oscila entre 0 y 2147483647. El valor predeterminado es 0.

Si marker no se deja en blanco, la consulta comienza desde el recurso especificado por marker.

tags

No

String

Etiqueta de recurso.

El formato es el siguiente: clave1,valor1|clave2,valor2.

Múltiples etiquetas están separadas por barra vertical (|). La clave y el valor de cada etiqueta están separados por coma (,).

status

No

String

Estado de los conjuntos de registros que se van a consultar. El valor puede ser ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE o PENDING_DELETE.

type

No

String

Tipo de conjunto de registros.- Zonas públicas: El tipo puede ser A, AAAA, MX, CNAME, TXT, NS, SRV o CAA.- Zonas privadas: El valor puede ser A, AAAA, MX, CNAME, TXT o SRV.

name

No

String

Nombre del conjunto de registros que se va a consultar. La búsqueda difusa funcionará. Se deja en blanco por defecto.

id

No

String

ID del conjunto de registros que se va a consultar. La búsqueda difusa funcionará. Se deja en blanco por defecto.

records

No

String

Registros incluidos en los valores de los conjuntos de registros que se van a consultar. La búsqueda difusa funcionará. Se deja en blanco por defecto.

sort_key

No

String

Campo de clasificación de los conjuntos de registros de la lista.

Opciones de valor:

  • name: nombre de dominio

  • type: tipo de conjunto de registro

El valor predeterminado se deja en blanco, lo que indica que los conjuntos de registros no están ordenados.

sort_dir

No

String

Orden de clasificación de los conjuntos de registros de la lista.

Opciones de valor:

  • desc: orden descendente

  • asc: orden ascendente

El valor predeterminado se deja en blanco, lo que indica que los conjuntos de registros no están ordenados.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario. Se puede obtener mediante invocación a una API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Parámetros de respuesta

Código de estado: 200

Tabla 3 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

links

pageLink object

Enlace del recurso actual u otros recursos relacionados. Cuando una respuesta se divide en páginas, se proporciona un siguiente enlace para recuperar todos los resultados.

recordsets

Array of ListRecordSetsWithTags objects

Lista de conjuntos de registros

metadata

metadata object

Número de recursos que cumplen la condición de consulta

Tabla 4 ListRecordSetsWithTags

Parámetro

Tipo

Descripción

id

String

ID de conjunto de registros

name

String

Nombre del conjunto de registros

description

String

Descripción del conjunto de registros

zone_id

String

ID de zona del conjunto de registros

zone_name

String

Nombre de la zona del conjunto de registros

type

String

Tipo de conjunto de registros

ttl

Integer

Duración del almacenamiento en caché del conjunto de registros (en segundos) en un servidor DNS local. Cuanto más larga sea la duración, más lenta será la actualización.

records

Array of strings

Valor establecido del registro

create_at

String

Hora en la que se creó el conjunto de registros

update_at

String

Hora en la que se actualizó el conjunto de registros

status

String

Estado del recurso

default

Boolean

Si el conjunto de registros es generado por el sistema. No se puede eliminar un conjunto de registros generado por el sistema.

project_id

String

ID de proyecto del conjunto de registros

links

pageLink object

Enlace del recurso actual u otros recursos relacionados. Cuando una respuesta se divide en páginas, se proporciona un siguiente enlace para recuperar todos los resultados.

tags

Array of tag objects

Etiqueta del recurso

Tabla 6 tag

Parámetro

Tipo

Descripción

key

String

Clave de etiqueta. Una clave puede contener hasta 36 caracteres Unicode. No se puede dejar en blanco. Un valor de etiqueta no puede contener caracteres especiales (=*<>,|/) ni empezar o terminar con espacios.

value

String

Valor de etiqueta. Un valor de etiqueta contiene un máximo de 43 caracteres de Unicode y se puede dejar en blanco. Un valor de etiqueta no puede contener caracteres especiales (=*<>,|/) ni empezar o terminar con espacios.

Tabla 7 metadata

Parámetro

Tipo

Descripción

total_count

Integer

Número de recursos que cumplen los criterios de filtro. El número es irrelevante para limit u offset.

Ejemplo de solicitudes

Ninguna

Ejemplo de respuestas

Código de estado: 200

Respuesta a la solicitud de consulta de los conjuntos de registros

{
  "links" : {
    "self" : "https://Endpoint/v2/recordsets",
    "next" : "https://Endpoint/v2/recordsets?id=&limit=10&marker=2c9eb155587194ec01587224c9f9014a"
  },
  "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/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T11:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587194ec01587224c9f9014c",
    "name" : "example.com.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T11:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722996ca0002",
    "name" : "example.org.",
    "type" : "SOA",
    "ttl" : 300,
    "records" : [ "ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)" ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"
    },
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "create_at" : "2016-11-17T12:01:17.996",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722996ca0004",
    "name" : "example.org.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"
    },
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "create_at" : "2016-11-17T12:01:17.996",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "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" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T12:03:17.827",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  } ],
  "metadata" : {
    "total_count" : 5
  }
}

Código de muestra del SDK

El código de ejemplo del SDK es el siguiente.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class ListRecordSetsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("cn-north-4"))
                .build();
        ListRecordSetsRequest request = new ListRecordSetsRequest();
        request.withZoneType("<zone_type>");
        request.withMarker("<marker>");
        request.withSearchMode("<search_mode>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withTags("<tags>");
        request.withStatus("<status>");
        request.withType("<type>");
        request.withName("<name>");
        request.withId("<id>");
        request.withRecords("<records>");
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        try {
            ListRecordSetsResponse response = client.listRecordSets(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListRecordSetsRequest()
        request.zone_type = "<zone_type>"
        request.marker = "<marker>"
        request.search_mode = "<search_mode>"
        request.limit = <limit>
        request.offset = <offset>
        request.tags = "<tags>"
        request.status = "<status>"
        request.type = "<type>"
        request.name = "<name>"
        request.id = "<id>"
        request.records = "<records>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        response = client.list_record_sets(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListRecordSetsRequest{}
	zoneTypeRequest:= "<zone_type>"
	request.ZoneType = &zoneTypeRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	searchModeRequest:= "<search_mode>"
	request.SearchMode = &searchModeRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	tagsRequest:= "<tags>"
	request.Tags = &tagsRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	recordsRequest:= "<records>"
	request.Records = &recordsRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	response, err := client.ListRecordSets(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

Más información

Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulta la pestaña Código de ejemplo en Explorador de API. El código de ejemplo del SDK se puede generar automáticamente.

Códigos de estado

Código de estado

Descripción

200

Respuesta a la solicitud de consulta de los conjuntos de registros

Códigos de error

Consulte Códigos de error.