Consulta de detalhes sobre um disco EVS
Função
Esta API é usada para consultar detalhes sobre um disco EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v2/{project_id}/volumes/{volume_id}
|
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. |
|
volume_id |
Sim |
String |
O ID do disco. |
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 |
|---|---|---|
|
volume |
CinderVolumeDetail object |
O disco retornado. |
|
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. |
|
status |
String |
O status do disco. Para obter detalhes, consulte Status do disco EVS. |
|
attachments |
Array of VolumeAttachment objects |
Se o disco está anexado. |
|
availability_zone |
String |
A AZ à qual o disco pertence. |
|
source_volid |
String |
O ID do disco de origem. Este parâmetro tem um valor se o disco for criado a partir de um disco de origem. Este campo não é suportado no momento. |
|
snapshot_id |
String |
O ID do snapshot. Este parâmetro tem um valor se o disco for criado a partir de um snapshot. |
|
description |
String |
A descrição do disco. |
|
bootable |
String |
Se o disco é inicializável. true: o disco é inicializável. false: o disco não é inicializável. |
|
created_at |
String |
A hora em que o disco foi criado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
|
volume_type |
String |
O tipo de disco. O valor pode ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 ou ESSD2.
|
|
metadata |
VolumeMetadata object |
Os metadados do disco. Se metadata não contiver o campo hw:passthrough, o tipo de dispositivo de disco será VBD. Se metadata não contiver o campo __system__encrypted, o disco não será criptografado. |
|
size |
Integer |
O tamanho do disco, em GiB. |
|
shareable |
Boolean |
Se o disco é compartilhável. Observação: este campo foi preterido. Use multiattach. |
|
multiattach |
Boolean |
Se o disco é compartilhável. |
|
os-vol-tenant-attr:tenant_id |
String |
O ID do locatário ao qual o disco pertence. O ID do locatário é o mesmo que o ID do projeto. |
|
volume_image_metadata |
Object |
Os metadados da imagem de disco. Para obter detalhes sobre o campo volume_image_metadata, consulte Consulta de detalhes da imagem (API OpenStack nativo). |
|
os-vol-host-attr:host |
String |
O campo reservado. |
|
os-volume-replication:extended_status |
String |
O campo reservado. |
|
consistencygroup_id |
String |
O campo reservado. |
|
iops |
iops object |
As informações de IOPS do disco. Este parâmetro é retornado apenas para um SSD V2 de uso geral ou um disco SSD V2 extremo. |
|
throughput |
throughput object |
As informações de taxa de transferência do disco. Este parâmetro é retornado apenas para um disco SSD V2 de propósito geral. |
|
updated_at |
String |
A hora em que o disco foi atualizado. |
|
replication_status |
String |
O campo reservado. |
|
user_id |
String |
O campo reservado. |
|
encrypted |
Boolean |
O campo reservado. |
|
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 |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
attached_at |
String |
A hora em que o disco foi anexado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
|
attachment_id |
String |
O ID do anexo. |
|
device |
String |
O nome do dispositivo. |
|
host_name |
String |
O nome do host físico que hospeda o servidor de nuvem ao qual o disco está anexado. |
|
id |
String |
O ID do disco anexado. |
|
server_id |
String |
O ID do servidor ao qual o disco está anexado. |
|
volume_id |
String |
O ID do disco. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
__system__cmkid |
String |
O ID da CMK de encriptação em metadata. Este parâmetro é utilizado em conjunto com __system__encrypted para encriptação. O comprimento do cmkid é fixado em 36 bytes.
NOTA:
Use uma solicitação HTTPS para obter o ID da chave. Para obter detalhes, consulte Consulta da lista de chaves. |
|
__system__encrypted |
String |
O campo de encriptação nos metadata. O valor pode ser 0 (não criptografado) ou 1 (criptografado). Se esse parâmetro não aparecer, o disco não será criptografado. |
|
full_clone |
String |
Se o disco for criado a partir de um snapshot e a clonagem vinculada precisar ser usada, defina esse parâmetro como 0. |
|
hw:passthrough |
String |
Se esse parâmetro for definido como true, o tipo de dispositivo de disco será SCSI, o que permite que os SOs do ECS acessem diretamente a mídia de armazenamento subjacente. Os comandos de reserva SCSI são suportados. Se esse parâmetro for definido como false, o tipo de dispositivo de disco será VBD, que também é o tipo padrão. O VBD suporta apenas comandos simples de leitura/gravação de SCSI. Se esse parâmetro não estiver disponível, o tipo de dispositivo de disco será VBD. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
frozened |
Boolean |
A tag congelada. Padrão: false |
|
id |
String |
O ID do IOPS do disco. |
|
total_val |
Integer |
O IOPS. |
|
volume_id |
String |
O ID do disco. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
frozened |
Boolean |
A tag congelada. Padrão: false |
|
id |
String |
O ID da taxa de transferência. |
|
total_val |
Integer |
A taxa de transferência. |
|
volume_id |
String |
O ID do disco. |
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}/v2/{project_id}/volumes/{volume_id}
Exemplo de respostas
Código de status: 200
OK
{
"volume" : {
"attachments" : [ ],
"links" : [ {
"href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
"rel" : "self"
}, {
"href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
"rel" : "bookmark"
} ],
"availability_zone" : "az-dc-1",
"os-vol-host-attr:host" : "az-dc-1#SSD",
"encrypted" : false,
"multiattach" : true,
"updated_at" : "2016-02-03T02:19:29.895237",
"replication_status" : "disabled",
"id" : "591ac654-26d8-41be-bb77-4f90699d2d41",
"size" : 40,
"user_id" : "fd03ee73295e45478d88e15263d2ee4e",
"os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48",
"os-volume-replication:extended_status" : null,
"snapshot_id" : null,
"volume_image_metadata" : null,
"os-vol-mig-status-attr:migstat" : null,
"metadata" : { },
"status" : "error_restoring",
"description" : "auto-created_from_restore_from_backup",
"name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
"bootable" : "false",
"created_at" : "2016-02-03T02:19:11.723797"
}
}
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.