Consulta de discos EVS
Função
Esta API é usada para consultar discos EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v3/{project_id}/volumes
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
O ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
marker |
Não |
String |
O ID do recurso a partir do qual a consulta de paginação é iniciada. É o ID do último recurso na página anterior. |
name |
Não |
String |
O nome do disco. Você pode inserir até 64 caracteres. |
limit |
Não |
Integer |
O número máximo de resultados de consulta que podem ser retornados. O valor varia de 1 a 1000 e o valor padrão é 1000. O valor retornado não pode exceder esse limite. Se você tiver mais de 50 discos no total, use este parâmetro e defina como 50 para melhorar a eficiência da consulta. Os exemplos são fornecidos como a seguir: Consulta de 1–50 discos: GET /v2/xxx/volumes?limit=50 Consulta de 51–100 discos: GET /v2/xxx/volumes?offset=50&limit=50 |
sort_dir |
Não |
String |
A ordem de classificação do resultado. O valor padrão é desc. desc: a ordem decrescente asc: a ordem crescente |
sort_key |
Não |
String |
Palavra-chave com base na qual os resultados retornados são classificados. O valor pode ser id, status, size ou created_at, e o valor padrão é created_at. |
offset |
Não |
Integer |
O deslocamento da consulta. Todos os discos após esse deslocamento serão consultados. O valor deve ser um número inteiro maior que 0, mas menor que o número de discos. |
status |
Não |
String |
O status do disco. Para obter detalhes, consulte Status do disco EVS. |
metadata |
Não |
String |
Os metadados do disco. |
availability_zone |
Não |
String |
A informação da AZ. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
O token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
volumes |
Array of VolumeBody objects |
A lista de discos retornados. |
volumes_links |
Array of Link objects |
O marcador de posição da consulta na lista de discos. Se apenas alguns discos forem retornados nesta consulta, o URL do último disco consultado será retornado. Você pode usar esse URL para continuar a consultar os discos restantes na próxima consulta. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
O ID do disco. |
links |
Array of Link objects |
O URI do disco. |
name |
String |
O nome do disco. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
href |
String |
O link de atalho correspondente. |
rel |
String |
O nome do marcador do link de atalho. Padrão: next |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
A mensagem de erro retornada se ocorrer um erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
O código de erro retornado se ocorrer um erro. Para obter detalhes sobre códigos de erro e seus significados, consulte Códigos de erro. |
message |
String |
A mensagem de erro retornada se ocorrer um erro. |
Exemplo de solicitações
GET https://{endpoint}/v3/{project_id}/volumes?status=available
Exemplo de respostas
Código de status: 200
OK
{ "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 status: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Bad Request |
Códigos de erro
Consulte Códigos de erro.