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 grupos de líneas

Función

Esta API se utiliza para consultar los grupos de líneas. Esta API no está disponible en algunas regiones. Para usar esta API, envíe un ticket de servicio.

Método de invocación

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

URI

GET /v2.1/linegroups

Tabla 1 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

line_id

No

String

ID de grupo de líneas. La búsqueda difusa funcionará.

name

No

String

Nombre del grupo de líneas. La búsqueda difusa funcionará.

limit

No

Integer

Número de recursos en cada página.

Cuando se consulta información detallada, el valor varía de 0 a 100. Los valores más utilizados son 10, 20 y 50 y el valor predeterminado es 100.

Cuando consulta la información breve, el valor varía de 0 a 3000 y el valor predeterminado es 3000.

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.

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

linegroups

Array of CreateLineGroupsResp objects

Objeto de lista

metadata

metadata object

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

Tabla 4 CreateLineGroupsResp

Parámetro

Tipo

Descripción

name

String

Nombre del grupo de líneas

lines

Array of strings

Lista de líneas contenidas en un grupo de líneas (Los ID de línea de resolución se utilizan aquí.)

status

String

Estado del recurso.

Opciones de valor: PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE y DISABLE

description

String

Descripción del grupo de líneas

line_id

String

ID de grupo de líneas

created_at

String

Hora en la que se creó el grupo de líneas.

Formato: aaaa-MM-dd'T'HH:mm:ss.SSS.

updated_at

String

Hora en la que se actualizó el grupo de líneas.

Formato: aaaa-MM-dd'T'HH:mm:ss.SSS.

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.

Código de estado: 400

Tabla 6 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

code

String

Código de error

Mínimo: 8

Máximo: 36

message

String

Descripción

Mínimo: 2

Máximo: 512

Código de estado: 500

Tabla 7 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

code

String

Código de error

Mínimo: 8

Máximo: 36

message

String

Descripción

Mínimo: 2

Máximo: 512

Ejemplo de las solicitudes

Ninguna

Ejemplo de respuestas

Código de estado: 200

Respuesta a la solicitud de consulta de los grupos de líneas

{
  "linegroups" : [ {
    "name" : "linegroup",
    "lines" : [ "ST", "LA" ],
    "status" : "ACTIVE",
    "description" : "123",
    "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
    "created_at" : "2019-07-29T08:41:38.096",
    "updated_at" : "2019-07-29T08:41:38.610"
  }, {
    "name" : "20190729034848812group",
    "lines" : [ "Liantong", "Dianxin_Guangdong" ],
    "status" : "ACTIVE",
    "description" : "auto create",
    "line_id" : "lgroup_4011afa26c33050b016c3cbeaf650f84",
    "created_at" : "2019-07-29T08:00:25.443",
    "updated_at" : "2019-07-29T08:00:26.040"
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

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

    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();
        ListLineGroupsRequest request = new ListLineGroupsRequest();
        request.withLineId("<line_id>");
        request.withName("<name>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListLineGroupsResponse response = client.listLineGroups(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
# 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 = ListLineGroupsRequest()
        request.line_id = "<line_id>"
        request.name = "<name>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_line_groups(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
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.ListLineGroupsRequest{}
	lineIdRequest:= "<line_id>"
	request.LineId = &lineIdRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListLineGroups(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 grupos de líneas

400

Respuesta de error

500

Respuesta de error

Códigos de error

Consulte Códigos de error.