Consulta de detalles de discos de EVS por etiqueta
Función
Esta API se utiliza para consultar los detalles de los discos de EVS por etiqueta.
Método de invocación
Para obtener más información, consulte Invocación de las API.
Información de autorización
Cada cuenta tiene todos los permisos necesarios para invocar todas las API, pero los usuarios de IAM deben tener asignados los permisos requeridos.
- Si está utilizando la autorización basada en roles/políticas, consulte Políticas de permisos y acciones admitidas para obtener más información sobre los permisos requeridos.
- Si está utilizando la autorización basada en políticas de identidad, no se requiere ningún permiso basado en políticas de identidad para invocar esta API.
URI
POST /v2/{project_id}/cloudvolumes/resource_instances/action
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | Definición El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Definición El token de usuario. Puede obtenerlo invocando la API de IAM para obtener un token de usuario. El token es el valor de X-Subject-Token en el encabezado de respuesta. Restricciones N/D Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| action | Sí | String | Definición El identificador de operación. Restricciones N/D Rango Utilice filter para consultar los detalles de los discos por etiqueta. Valor predeterminado N/D |
| limit | No | Integer | Definición Cantidad máxima de registros de consulta que se pueden devolver. Restricciones Valor mínimo: 1; valor máximo: 1000 Rango 1–1000 Valor predeterminado 1000 |
| matches | No | Array of Match objects | Definición Los criterios de búsqueda admitidos por los recursos. Restricciones Las claves de etiqueta de una lista de etiquetas deben ser únicas. Rango N/D Valor predeterminado N/D |
| offset | No | Integer | Definición El desplazamiento. Restricciones Este parámetro se utiliza junto con *limit al consultar los discos de EVS. Supongamos que hay 30 discos. Si establece offset en 11 y limit en 10, la consulta comienza desde el duodécimo disco. Se puede consultar un máximo de 10 discos a la vez. Rango N/D Valor predeterminado N/D |
| tags | Yes | Array of TagsForListVolumes objects | Definición Los pares de clave-valor de las etiquetas. Restricciones Una lista de etiquetas puede contener un máximo de 10 claves. Las claves de etiquetas en una lista de etiquetas deben ser únicas. Cuando se especifican varias claves en una lista de etiquetas, solo se consultan los discos que tienen todas las claves especificadas. Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| key | Sí | String | Definición La clave de la etiqueta. Restricciones N/D Rango
Valor predeterminado N/D |
| value | Sí | String | Definición El valor de la etiqueta. Restricciones Puede contener hasta 255 caracteres. Si se especifica resource_name para key, el valor de la etiqueta utiliza la coincidencia difusa. Rango N/D Valor predeterminado N/D |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| key | Sí | String | Definición La clave de la etiqueta. Restricciones Las claves de etiquetas de un recurso deben ser únicas. Una clave de etiqueta puede contener un máximo de 36 caracteres. Rango Conjunto de caracteres: A-Z, a-z, 0-9, guiones medios (-), guiones bajos (_) y caracteres Unicode (\u4E00-\u9FFF) Valor predeterminado N/D |
| values | Sí | Array of strings | Definición Los valores de etiquetas. Restricciones Una lista de etiquetas puede contener un máximo de 10 valores. Los valores de etiquetas en una lista de etiquetas deben ser únicos. Si la lista de valores está vacía, se coincide con cualquier valor de etiqueta. Cuando hay múltiples valores y se cumplen los requisitos clave, se consultan los discos que tienen cualquiera de los valores especificados. Rango Conjunto de caracteres: A-Z, a-z, 0-9, puntos (.), guiones medios (-), guiones bajos (_) y caracteres Unicode (\u4E00-\u9FFF) Valor predeterminado N/D |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| total_count | Integer | Definición La cantidad de discos que cumplen los criterios de consulta. Rango N/D |
| resources | Array of Resource objects | Definición La lista de recursos que cumplen los criterios de consulta. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| resource_id | String | Definición El ID del recurso. Rango N/D |
| resource_name | String | Definición El nombre del recurso. Rango N/D |
| resource_detail | VolumeDetailForTag object | Definición Los detalles del recurso. Rango N/D |
| tags | Array of Map<String,String> objects | Definición La lista de etiquetas. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | Definición El ID del disco. Rango N/D |
| links | Array of Link objects | Definición El URI del disco. Rango N/D |
| name | String | Definición El nombre del disco. Rango N/D |
| status | String | Definición El estado del disco. Para obtener más información, consulte Estado del disco de EVS. Rango N/D |
| attachments | Array of Attachment objects | Definición La información de conexión del disco. Rango N/D |
| availability_zone | String | Definición La AZ a la que pertenece el disco. Rango N/D |
| os-vol-host-attr:host | String | Definición El campo reservado. Rango N/D |
| source_volid | String | Definición El ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Actualmente, este campo no se admite. Rango N/D |
| snapshot_id | String | Definición El ID de la instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea. Rango N/D |
| description | String | Definición La descripción del disco. Rango N/D |
| created_at | String | Definición La hora en que se creó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| os-vol-tenant-attr:tenant_id | String | Definición El ID del tenant al que pertenece el disco. El ID del tenant es el mismo que el ID del proyecto. Rango N/D |
| volume_image_metadata | Map<String,Object> | Definición Los metadatos de la imagen del disco. NOTA: Para obtener más información sobre el campo volume_image_metadata, consulte Consulta de detalles de imágenes (API nativa de OpenStack). Rango N/D |
| volume_type | String | Definición El tipo de disco. Rango El valor puede ser SSD, SAS o SATA.
|
| size | Integer | Definición La capacidad del disco, en GiB. Rango N/D |
| consistencygroup_id | String | Definición El campo reservado. Rango N/D |
| bootable | String | Definición Si el disco es arrancable. Rango true: El disco es arrancable. false: El disco no es arrancable. |
| metadata | VolumeMetadata object | Definición Los metadatos del disco. Rango N/D |
| updated_at | String | Definición La hora en que se actualizó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| encrypted | Boolean | Definición Actualmente, este campo no se admite. Rango N/D |
| replication_status | String | Definición El campo reservado. Rango N/D |
| os-volume-replication:extended_status | String | Definición El campo reservado. Rango N/D |
| os-vol-mig-status-attr:migstat | String | Definición El campo reservado. Rango N/D |
| os-vol-mig-status-attr:name_id | String | Definición El campo reservado. Rango N/D |
| shareable | Boolean | Definición Si el disco es compartible. Este campo ha sido obsoleto. Utilice multiattach. Rango
|
| user_id | String | Definición El campo reservado. Rango N/D |
| service_type | String | Definición El tipo de servicio. Rango
|
| multiattach | Boolean | Definición Si el disco es compartible. Rango
|
| dedicated_storage_id | String | Definición El ID del grupo de almacenamiento dedicado que aloja el disco. Rango N/D |
| dedicated_storage_name | String | Definición El nombre del grupo de almacenamiento dedicado que aloja el disco. Rango N/D |
| tags | Map<String,String> | Definición Las etiquetas del disco. Este campo tiene valores si el disco tiene etiquetas. O bien, se deja vacío. Rango N/D |
| wwn | String | Definición El identificador único utilizado al conectar el disco. Rango N/D |
| enterprise_project_id | String | Definición El ID del proyecto empresarial al que se ha agregado el disco. Para obtener más información sobre los proyectos empresariales y cómo obtener los ID de proyecto empresarial, consulte Descripción del centro empresarial. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| href | String | Definición El enlace de acceso directo correspondiente. Rango N/D |
| rel | String | Definición El nombre del marcador del enlace de acceso directo. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| attached_at | String | Definición La hora en que se conectó el disco. Rango Formato de tiempo: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
| attachment_id | String | Definición El ID del adjunto. Rango N/D |
| device | String | Definición El nombre del dispositivo. Rango N/D |
| host_name | String | Definición El nombre del host físico que aloja el servidor en la nube al que está conectado el disco. Rango N/D |
| id | String | Definición El ID del disco conectado. Rango N/D |
| server_id | String | Definición El ID del servidor al que está conectado el disco. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| __system__cmkid | String | Definición El ID del CMK de encriptación en metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes. Para obtener detalles sobre cómo obtener el ID de clave, véase Consulta de la lista de claves. Rango N/D |
| __system__encrypted | String | Definición El campo de encriptación en metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si este parámetro no se especifica, el atributo de encriptación del disco es el mismo que el del origen de datos. Si el disco no se crea a partir de un origen de datos, el disco no se cifra de forma predeterminada. Rango
|
| hw:passthrough | String | Definición El tipo de dispositivo de disco. Rango
|
| orderID | String | Definición El parámetro que describe el modo de facturación de disco de metadata. Si este parámetro tiene un valor, el disco se factura anualmente/mensualmente. Si no se especifica este parámetro, el disco se factura en función del pago por uso. Rango N/D |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Error object | Definición El código de error devuelto si se produce un error. Para obtener más información sobre el código de error, consulte Códigos de error. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| code | String | Definición El código de error devuelto si se produce un error. Rango Para obtener más información sobre el código de error, consulte Códigos de error. |
| message | String | Definición El mensaje de error devuelto si se produce un error. Rango N/D |
Ejemplos de solicitudes
Consulta de detalles del disco shared01 mediante las etiquetas key_string,value_string y key_string02,value_string02 (La consulta comienza desde el décimo registro. La cantidad de registros devueltos no puede superar los 100).
POST https://{endpoint}/v2/{project_id}/cloudvolumes/resource_instances/action
{
"offset" : 9,
"limit" : 100,
"action" : "filter",
"tags" : [ {
"key" : "key_string",
"values" : [ "value_string" ]
}, {
"key" : "key_string02",
"values" : [ "value_string02" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "shared01"
}, {
"key" : "service_type",
"value" : "EVS"
} ]
} Ejemplos de respuestas
Código de estado: 200
OK
{
"total_count" : 1,
"resources" : [ {
"resource_name" : "resource1",
"resource_detail" : {
"attachments" : [ {
"server_id" : "2080869e-ba46-4ea5-b45e-3191ac0f1d54",
"attachment_id" : "1335f039-7a42-4d1e-be49-ac584db0ba0b",
"attached_at" : "2019-08-06T07:00:21.842812",
"volume_id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"device" : "/dev/vda",
"id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
} ],
"links" : [ {
"href" : "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"rel" : "self"
}, {
"href" : "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"rel" : "bookmark"
} ],
"availability_zone" : "kvmxen.dc1",
"os-vol-host-attr:host" : "az21.dc1#2",
"enterprise_project_id" : "0",
"updated_at" : "2019-08-09T06:19:35.874737",
"replication_status" : "disabled",
"id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"size" : 40,
"user_id" : "75f26e17348643bfb7718578b04635c2",
"os-vol-tenant-attr:tenant_id" : "051375756c80d5eb2ff0c014498645fb",
"service_type" : "EVS",
"metadata" : { },
"status" : "in-use",
"volume_image_metadata" : {
"size" : "0",
"__quick_start" : "False",
"container_format" : "bare",
"min_ram" : "0",
"image_name" : "test-hua-centos7.3-0725",
"image_id" : "c6c153a6-dde8-4bac-8e40-3d7619436934",
"__os_type" : "Linux",
"min_disk" : "20",
"__support_kvm" : "true",
"virtual_env_type" : "FusionCompute",
"__description" : "",
"__os_version" : "CentOS 7.3 64bit",
"__os_bit" : "64",
"__image_source_type" : "uds",
"__support_xen" : "true",
"file_format" : "zvhd2",
"checksum" : "d41d8cd98f00b204e9800998ecf8427e",
"__imagetype" : "gold",
"disk_format" : "zvhd2",
"__image_cache_type" : "Not_Cache",
"__isregistered" : "true",
"__image_location" : "192.149.46.200:5443:pcsimssouthchina:c6c153a6-dde8-4bac-8e40-3d7619436934",
"__image_size" : "911269888",
"__platform" : "CentOS"
},
"description" : "",
"multiattach" : false,
"name" : "resource1",
"bootable" : "true",
"created_at" : "2019-08-06T06:59:03.056682",
"volume_type" : "SAS",
"shareable" : false
},
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key1",
"value" : "value2"
} ],
"resource_id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
} ]
} Código de estado: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
} Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
Java
Consulta de detalles del disco shared01 mediante las etiquetas key_string,value_string y key_string02,value_string02 (La consulta comienza desde el décimo registro. La cantidad de registros devueltos no puede superar los 100).
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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | 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.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; import java.util.List; import java.util.ArrayList; public class ListVolumesByTagsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); ListVolumesByTagsRequest request = new ListVolumesByTagsRequest(); ListVolumesByTagsRequestBody body = new ListVolumesByTagsRequestBody(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("value_string02"); List<String> listTagsValues1 = new ArrayList<>(); listTagsValues1.add("value_string"); List<TagsForListVolumes> listbodyTags = new ArrayList<>(); listbodyTags.add( new TagsForListVolumes() .withKey("key_string") .withValues(listTagsValues1) ); listbodyTags.add( new TagsForListVolumes() .withKey("key_string02") .withValues(listTagsValues) ); List<Match> listbodyMatches = new ArrayList<>(); listbodyMatches.add( new Match() .withKey(Match.KeyEnum.fromValue("resource_name")) .withValue("shared01") ); listbodyMatches.add( new Match() .withKey(Match.KeyEnum.fromValue("service_type")) .withValue("EVS") ); body.withTags(listbodyTags); body.withOffset(9); body.withMatches(listbodyMatches); body.withLimit(100); body.withAction(ListVolumesByTagsRequestBody.ActionEnum.fromValue("filter")); request.withBody(body); try { ListVolumesByTagsResponse response = client.listVolumesByTags(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
Consulta de detalles del disco shared01 mediante las etiquetas key_string,value_string y key_string02,value_string02 (La consulta comienza desde el décimo registro. La cantidad de registros devueltos no puede superar los 100).
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 62 63 64 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVolumesByTagsRequest() listValuesTags = [ "value_string02" ] listValuesTags1 = [ "value_string" ] listTagsbody = [ TagsForListVolumes( key="key_string", values=listValuesTags1 ), TagsForListVolumes( key="key_string02", values=listValuesTags ) ] listMatchesbody = [ Match( key="resource_name", value="shared01" ), Match( key="service_type", value="EVS" ) ] request.body = ListVolumesByTagsRequestBody( tags=listTagsbody, offset=9, matches=listMatchesbody, limit=100, action="filter" ) response = client.list_volumes_by_tags(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
Consulta de detalles del disco shared01 mediante las etiquetas key_string,value_string y key_string02,value_string02 (La consulta comienza desde el décimo registro. La cantidad de registros devueltos no puede superar los 100).
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 62 63 64 65 66 67 68 69 70 71 72 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListVolumesByTagsRequest{} var listValuesTags = []string{ "value_string02", } var listValuesTags1 = []string{ "value_string", } var listTagsbody = []model.TagsForListVolumes{ { Key: "key_string", Values: listValuesTags1, }, { Key: "key_string02", Values: listValuesTags, }, } var listMatchesbody = []model.Match{ { Key: model.GetMatchKeyEnum().RESOURCE_NAME, Value: "shared01", }, { Key: model.GetMatchKeyEnum().SERVICE_TYPE, Value: "EVS", }, } offsetListVolumesByTagsRequestBody:= int32(9) limitListVolumesByTagsRequestBody:= int32(100) request.Body = &model.ListVolumesByTagsRequestBody{ Tags: listTagsbody, Offset: &offsetListVolumesByTagsRequestBody, Matches: &listMatchesbody, Limit: &limitListVolumesByTagsRequestBody, Action: model.GetListVolumesByTagsRequestBodyActionEnum().FILTER, } response, err := client.ListVolumesByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Más
Para obtener el código de ejemplo de SDK de más lenguajes de programación, consulte 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 | OK |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.