Consulta de detalhes sobre um disco EVS (preterido)
Função
Esta API é usada para consultar detalhes sobre um único disco EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v3/{project_id}/os-vendor-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 |
Um token obtido do IAM é válido por apenas 24 horas. Ao usar um token para autenticação, armazene-o em cache para evitar chamar a API com frequência. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
volume |
VolumeDetailV3 object |
As informações do disco retornado. Para obter detalhes, consulte Parâmetros no campo volume. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
attachments |
Array of AttachmentV3 objects |
As informações de anexo do disco. Para obter detalhes, consulte |
availability_zone |
String |
A AZ à qual o disco pertence. |
bootable |
String |
Se o disco é inicializável. true: o disco é inicializável. false: o disco não é inicializável. |
consistencygroup_id |
String |
O campo reservado. |
created_at |
String |
A hora em que o disco foi criado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
dedicated_storage_id |
String |
O ID do pool de armazenamento dedicado que aloja o disco. |
dedicated_storage_name |
String |
O nome do pool de armazenamento dedicado que aloja o disco. |
description |
String |
A descrição do disco. |
encrypted |
Boolean |
Este campo não é suportado no momento. |
enterprise_project_id |
String |
O ID do projeto empresarial ao qual o disco foi adicionado. Para obter mais informações sobre projetos empresariais e como obter IDs de projetos empresariais, consulte |
id |
String |
O ID do disco. |
links |
Array of LinkV3 objects |
O URI do disco. Para obter detalhes, consulte |
metadata |
VolumeMetadataV3 object |
Os metadados. |
multiattach |
Boolean |
Se o disco é compartilhável. true: o disco é compartilhável. false: o disco não pode ser compartilhado. |
name |
String |
O nome do disco. |
replication_status |
String |
O campo reservado. |
service_type |
String |
O tipo de serviço. Os serviços suportados são EVS, DSS e DESS. |
shareable |
Boolean |
Se o disco é compartilhável.
NOTA:
Este campo foi preterido. Use multiattach. |
size |
Integer |
O tamanho do disco, em GiB. |
snapshot_id |
String |
O ID do snapshot. Este parâmetro tem um valor se o disco for criado a partir de um snapshot. |
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. |
status |
String |
O status do disco. |
tags |
Map<String,String> |
As tags do disco. Este campo tem valores se o disco tiver tags. Ou, é deixado vazio. |
updated_at |
String |
A hora em que o disco foi atualizado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
user_id |
String |
O campo reservado. |
volume_image_metadata |
Object |
Os metadados da imagem de disco.
NOTA:
Para obter detalhes sobre o campo volume_image_metadata, consulte Consulta de detalhes da imagem (API OpenStack nativo). |
volume_type |
String |
O tipo de disco. O valor pode ser SATA, SAS, GPSSD ou SSD.
|
wwn |
String |
O identificador exclusivo usado ao anexar o disco. |
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. |
os-vol-mig-status-attr:migstat |
String |
O campo reservado. |
os-vol-mig-status-attr:name_id |
String |
O campo reservado. |
os-volume-replication:extended_status |
String |
O campo reservado. |
os-vol-host-attr:host |
String |
O campo reservado. |
storage_cluster_id |
String |
O campo reservado. |
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 |
---|---|---|
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 |
---|---|---|
__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. |
__system__encrypted |
String |
O campo de encriptação nos metadata. 0: sem criptografia 1: criptografia. Se este parâmetro não aparecer, o disco não será criptografado. |
full_clone |
String |
O método de criação quando o disco é criado a partir de um snapshot.
|
hw:passthrough |
String |
Especifica o parâmetro que descreve o tipo de dispositivo de disco em metadata.
|
orderID |
String |
O parâmetro que descreve o modo de cobrança do disco em metadata. Se esse parâmetro tiver um valor, o disco será cobrado anualmente/mensalmente. Caso contrário, o disco é cobrado em uma base de pagamento por uso. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
A mensagem de erro retornada se ocorrer um erro. Para obter detalhes, consulte Parâmetros no campo error. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
O código de erro retornado se ocorrer um erro. Para os 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}/os-vendor-volumes/{volume_id}
Exemplo de respostas
Código de status: 200
OK
{ "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v3/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", "metadata" : { }, "tags" : { "key1" : "value1", "key2" : "value2" }, "enterprise_project_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "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", "service_type" : "EVS", "wwn" : "688860300000d136fa16f48f05992360", "backup_id" : "null" } }
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.