Consulta de discos de EVS
Función
Esta API se utiliza para consultar discos de EVS.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v2/{project_id}/volumes
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
El ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
marker |
No |
String |
El ID del recurso desde el que se inicia la consulta de paginación. Es el ID del último recurso de la página anterior. |
|
name |
No |
String |
El nombre del disco. Puede escribir hasta 64 caracteres. |
|
limit |
No |
Integer |
El número máximo de resultados de consulta que se pueden devolver. El valor oscila entre 1 y 1000 y el valor predeterminado es 1000. El valor devuelto no puede exceder este límite. Si tiene más de 50 discos en total, utilice este parámetro y configúrelo en 50 para mejorar la eficiencia de la consulta. Los ejemplos se proporcionan como sigue: Consulta de 1 a 50 discos: GET /v2/xxx/volumes?limit=50 Consulta de 51 a 100 discos: GET /v2/xxx/volumes?offset=50&limit=50 |
|
sort_dir |
No |
String |
El orden de clasificación del resultado. El valor predeterminado es desc. desc: orden descendente asc: orden ascendente |
|
sort_key |
No |
String |
La palabra clave en función de la cual se ordenan los resultados devueltos. El valor puede ser id, status, size, o created_at, y el valor predeterminado es created_at. |
|
offset |
No |
Integer |
El desplazamiento de la consulta. Todos los discos después de este desplazamiento serán consultados. El valor debe ser un entero mayor que 0 pero menor que el número de discos. |
|
status |
No |
String |
El estado del disco. Para obtener más detalles, consulte Estado del disco de EVS. |
|
metadata |
No |
String |
Los metadatos del disco. |
|
availability_zone |
No |
String |
La información de zona de disponibilidad. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
El token del usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. 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 |
|---|---|---|
|
volumes |
Array of VolumeBody objects |
La lista de discos devueltos. |
|
volumes_links |
Array of Link objects |
El marcador de posición de la consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devuelve la dirección URL del último disco consultado. Puede utilizar esta dirección URL para continuar consultando los discos restantes en la siguiente consulta. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
El ID del disco. |
|
links |
Array of Link objects |
El URI del disco. |
|
name |
String |
El nombre del disco. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
href |
String |
El enlace de acceso directo correspondiente. |
|
rel |
String |
El nombre del marcador de enlace de acceso directo. Valor predeterminado: next |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error |
Error object |
El mensaje de error devuelto si se produce un error. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
code |
String |
El código de error devuelto si se produce un error. Para obtener más detalles sobre los códigos de error y sus significados, consulte Códigos de error. |
|
message |
String |
El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
GET https://{endpoint}/v2/{project_id}/volumes
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"volumes" : [ {
"id" : "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"rel" : "bookmark"
} ],
"name" : "zjb_u25_test"
}, {
"id" : "2bce4552-9a7d-48fa-8484-abbbf64b206e",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
"rel" : "bookmark"
} ],
"name" : "zjb_u25_test"
}, {
"id" : "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel" : "bookmark"
} ],
"name" : "zjb_u25_test"
} ],
"volumes_links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel" : "next"
} ]
}
Código de estado: 400
Error en la solicitud
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
400 |
Error en la solicitud |
Códigos de error
Consulte Códigos de error.
