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 una línea personalizada

Función

Esta API se utiliza para consultar una línea personalizada.

Método de invocación

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

URI

GET /v2.1/customlines

Tabla 1 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

line_id

No

String

ID de línea de resolución

name

No

String

Nombre de línea de resolución

limit

No

Integer

Número de recursos en cada página.

El valor oscila entre 0 y 500.

Los valores más utilizados son 10, 20 y 50 y el valor predeterminado es 500.

offset

No

Integer

Iniciar 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.

show_detail

No

Boolean

Si desea consultar información detallada.

Opciones de valor:

  • true (predeterminado): Se consulta la información detallada.

  • false: No se consulta información detallada.

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

lines

Array of line objects

Lista de línea

metadata

metadata object

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

Tabla 4 line

Parámetro

Tipo

Descripción

line_id

String

ID de línea de resolución

name

String

Nombre de línea personalizado

ip_segments

Array of strings

Rango de direcciones IP

created_at

String

Hora en que se creó la línea

updated_at

String

Hora en que se actualizó la línea

status

String

Estado del recurso

description

String

Descripción de línea personalizada

Tabla 5 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

Consulta de una línea personalizada

{
  "lines" : [ {
    "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007",
    "name" : "customline",
    "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ],
    "status" : "ACTIVE",
    "created_at" : "2019-04-10T10:03:17.827",
    "updated_at" : "2019-04-10T10:03:57.207",
    "description" : "1234"
  } ],
  "metadata" : {
    "total_count" : 1
  }
}

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
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 ListCustomLineSolution {

    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();
        ListCustomLineRequest request = new ListCustomLineRequest();
        request.withLineId("<line_id>");
        request.withName("<name>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withShowDetail(<show_detail>);
        try {
            ListCustomLineResponse response = client.listCustomLine(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
# 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 = ListCustomLineRequest()
        request.line_id = "<line_id>"
        request.name = "<name>"
        request.limit = <limit>
        request.offset = <offset>
        request.show_detail = <ShowDetail>
        response = client.list_custom_line(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
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.ListCustomLineRequest{}
	lineIdRequest:= "<line_id>"
	request.LineId = &lineIdRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	showDetailRequest:= <show_detail>
	request.ShowDetail = &showDetailRequest
	response, err := client.ListCustomLine(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

Consulta de una línea personalizada

Códigos de error

Consulte Códigos de error.