Consulta de zonas privadas
Función
Esta API se utiliza para consultar zonas privadas.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v2/zones
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
type |
Sí |
String |
Tipo de zona. El valor es private. Predeterminado: private |
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. |
marker |
No |
String |
Iniciar ID de recurso al principio para la consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página. Este parámetro se deja vacío por defecto. |
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. |
tags |
No |
String |
Etiqueta del recurso |
name |
No |
String |
Nombre de la zona |
status |
No |
String |
Estado del recurso |
search_mode |
No |
String |
Modo de búsqueda. Las opciones son las siguientes:
|
enterprise_project_id |
No |
String |
ID del proyecto de empresa asociado a la zona. El valor contiene un máximo de 36 caracteres. Se establece en 0 de forma predeterminada. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
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
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. |
metadata |
metadata object |
Número de recursos que cumplen la condición de consulta |
zones |
Array of PrivateZoneResp objects |
Lista de zonas |
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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de zona, que es un UUID utilizado para identificar la zona |
name |
String |
Nombre de la zona |
description |
String |
Descripción de la zona |
|
String |
Dirección de correo electrónico del administrador de la zona |
zone_type |
String |
Tipo de zona. El valor es private. |
ttl |
Integer |
Valor de TTL del registro de SOA establecido en la zona |
serial |
Integer |
Número de secuencia utilizado para identificar cambios en el archivo de zona en el conjunto de registros de SOA de la zona. El número de secuencia se utiliza para la sincronización entre los nodos maestro y esclavo. |
status |
String |
Estado del recurso |
record_num |
Integer |
Número de conjuntos de registros en la zona |
proxy_pattern |
String |
Modo de proxy de resolución recursiva para nombres de subdominios de zonas privadas. Opciones de valor:
|
pool_id |
String |
ID de grupo de la zona, que es asignado por el sistema |
project_id |
String |
ID del proyecto de la zona |
created_at |
String |
Hora en que se creó la zona |
updated_at |
String |
Hora en que se actualizó la zona |
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 |
masters |
Array of strings |
Servidores de DNS maestros, de los cuales los servidores esclavos obtienen información de DNS |
routers |
Array of RouterWithStatus objects |
Lista de VPCs asociados a la zona |
enterprise_project_id |
String |
ID del proyecto de empresa asociado a la zona. El valor contiene un máximo de 36 caracteres. |
Parámetro |
Tipo |
Descripción |
---|---|---|
self |
String |
Enlace al recurso actual |
next |
String |
Enlace a la página siguiente |
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 |
Tag value. 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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Estado del recurso |
router_id |
String |
ID de la VPC asociada a la zona |
router_region |
String |
Región de la VPC |
Código de estado: 400
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: 404
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
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 las respuestas
Código de estado: 200
Respuesta a la solicitud de consulta de zonas privadas
{ "links" : { "self" : "https://Endpoint/v2/zones?type=private&limit=10", "next" : "https://Endpoint/v2/zones?type=private&limit=10&marker=ff8080825b8fc86c015b94bc6f8712c3" }, "zones" : [ { "id" : "ff8080825b8fc86c015b94bc6f8712c3", "name" : "example.com.", "description" : "This is an example zone.", "email" : "xx@example.com", "ttl" : 300, "serial" : 0, "masters" : [ ], "tags" : [ ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2/zones/ff8080825b8fc86c015b94bc6f8712c3" }, "pool_id" : "ff8080825ab738f4015ab7513298010e", "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type" : "private", "created_at" : "2017-04-22T08:17:08.997", "updated_at" : "2017-04-22T08:17:09.997", "record_num" : 2, "proxy_pattern" : "AUTHORITY", "routers" : [ { "status" : "ACTIVE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" }, { "status" : "ACTIVE", "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b", "router_region" : "xx" } ], "enterprise_project_id" : 0 }, { "id" : "ff8080825b95142f015b951f87280029", "name" : "example.org.", "description" : "This is an example zone.", "email" : "xx@example.org", "ttl" : 300, "serial" : 0, "masters" : [ ], "tags" : [ ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2/zones/ff8080825b95142f015b951f87280029" }, "pool_id" : "ff8080825ab738f4015ab7513298010e", "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type" : "private", "created_at" : "2017-04-22T08:17:08.997", "updated_at" : "2017-04-22T08:17:09.997", "record_num" : 2, "proxy_pattern" : "AUTHORITY", "routers" : [ { "status" : "ACTIVE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" }, { "status" : "ACTIVE", "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b", "router_region" : "xx" } ], "enterprise_project_id" : 0 } ], "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 50 51 52 53 54 |
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 ListPrivateZonesSolution { 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(); ListPrivateZonesRequest request = new ListPrivateZonesRequest(); request.withType("<type>"); request.withLimit(<limit>); request.withMarker("<marker>"); request.withOffset(<offset>); request.withTags("<tags>"); request.withName("<name>"); request.withStatus("<status>"); request.withSearchMode("<search_mode>"); request.withEnterpriseProjectId("<enterprise_project_id>"); try { ListPrivateZonesResponse response = client.listPrivateZones(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 |
# 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 = ListPrivateZonesRequest() request.type = "<type>" request.limit = <limit> request.marker = "<marker>" request.offset = <offset> request.tags = "<tags>" request.name = "<name>" request.status = "<status>" request.search_mode = "<search_mode>" request.enterprise_project_id = "<enterprise_project_id>" response = client.list_private_zones(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 |
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.ListPrivateZonesRequest{} request.Type = "<type>" limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest tagsRequest:= "<tags>" request.Tags = &tagsRequest nameRequest:= "<name>" request.Name = &nameRequest statusRequest:= "<status>" request.Status = &statusRequest searchModeRequest:= "<search_mode>" request.SearchMode = &searchModeRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest response, err := client.ListPrivateZones(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 zonas privadas |
400 |
Respuesta de error |
404 |
Respuesta de error |
500 |
Respuesta de error |
Códigos de error
Consulte Códigos de error.