Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Elastic Volume Service/ Referência de API/ API Cinder/ Gerenciamento de disco/ Consulta de detalhes sobre todos os discos EVS

Atualizado em 2024-09-25 GMT+08:00

Ver PDF

Consulta de detalhes sobre todos os discos EVS

Função

Esta API é usada para consultar detalhes sobre todos os discos EVS.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v2/{project_id}/volumes/detail

**Tabela 1** Parâmetros de caminho
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.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
marker	Não	String	O ID do último registro na página anterior. O valor retornado é o valor do item após este.
name	Não	String	O nome do disco. Você pode inserir até 85 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/detail?limit=50 Consulta de 51–100 discos: GET /v2/xxx/volumes/detail?offset=50&limit=50
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.
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
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.
metadata	Não	String	Os metadados do disco. Este parâmetro é transferido no formato JSON, por exemplo, GET /v2/{project_id}/volumes/detail?metadata={"hw:passthrough": "true"}.
availability_zone	Não	String	A informação da AZ.

Parâmetros de solicitação

**Tabela 3** Parâmetros de cabeçalho 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

**Tabela 4** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
volumes	Array of VolumeDetail 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.

**Tabela 5** VolumeDetail
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.
encrypted	Boolean	Este campo não é suportado no momento.
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. SATA: o tipo de I/O comum (esgotado) SAS: o tipo de I/O alta GPSSD: o tipo de SSD de uso geral SSD: o tipo de I/O ultra-alta ESSD: o tipo de SSD extremo GPSSD2: o tipo de SSD V2 de uso geral ESSD2: o tipo de SSD V2 extremo
replication_status	String	O campo reservado.
consistencygroup_id	String	O campo reservado.
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.
user_id	String	O campo reservado.
updated_at	String	A hora em que o disco foi atualizado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX
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.
os-vol-mig-status-attr:migstat	String	O campo reservado.
os-vol-mig-status-attr:name_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.

**Tabela 6** VolumeAttachment
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.

**Tabela 7** VolumeMetadata
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.

**Tabela 8** iops
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.

**Tabela 9** throughput
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.

**Tabela 10** Link
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

**Tabela 11** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error	Error object	A mensagem de erro retornada se ocorrer um erro.

**Tabela 12** Error
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/detail

Exemplo de respostas

Código de status: 200

{
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "bootable" : "false",
    "created_at" : "2016-05-25T02:42:10.856332",
    "encrypted" : false,
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "self"
    }, {
      "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "bookmark"
    } ],
    "metadata" : { },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA",
    "consistencygroup_id" : null,
    "os-vol-mig-status-attr:migstat" : null,
    "os-vol-mig-status-attr:name_id" : null,
    "snapshot_id" : null,
    "source_volid" : null
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
    "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.

Tópico principal: Gerenciamento de disco

Tópico anterior: Consulta de detalhes sobre um disco EVS

Próximo tópico: Consulta de APIs de extensão

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar