Consulta de detalhes sobre todos os discos EVS (preterido)
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 /v3/{project_id}/os-vendor-volumes/detail
| 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 |
|---|---|---|---|
| availability_zone | Não | String | A AZ à qual o disco pertence. |
| dedicated_storage_id | Não | String | O ID do pool de armazenamento dedicado. Todos os discos no pool de armazenamento dedicado podem ser filtrados por correspondência exata. |
| dedicated_storage_name | Não | String | O nome do pool de armazenamento dedicado. Todos os discos no pool de armazenamento dedicado podem ser filtrados por correspondência difusa. |
| id | Não | String | O ID do disco. |
| ids | Não | Array | Os IDs do disco. O valor é no formato ids=['id1','id2',...,'idx']. Na resposta, o valor de ids contém apenas IDs de disco válidos. IDs de disco inválidos são ignorados. Os detalhes sobre um máximo de 60 discos podem ser consultados. Se ambos id e ids forem especificados na solicitação, id será ignorado. |
| 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. |
| 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. |
| metadata | Não | String | Os metadados do disco. |
| multiattach | Não | String | Se o disco é compartilhável. true: o disco é compartilhável. false: o disco não pode ser compartilhado. |
| name | Não | String | O nome do disco. Você pode inserir até 64 caracteres. |
| offset | Não | Integer | O deslocamento da consulta. Todos os discos após esse deslocamento são consultados. O valor deve ser um número inteiro maior que 0, mas menor que o número de discos. |
| service_type | Não | String | O tipo de serviço. Os serviços suportados são EVS, DSS e DESS. |
| 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. |
| status | Não | String | O status do disco. Para obter detalhes, consulte Status do disco EVS. |
| volume_type_id | Não | String | O ID do tipo de disco. Para obter detalhes, vá para Consulta de tipos de disco EVS e verifique o valor de id na tabela para obter parâmetros no campo volume_types. |
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 |
|---|---|---|
| count | Integer | O número total de discos consultados. |
| volumes | Array of VolumeDetailV3 objects | A lista de discos retornados. |
| volumes_links | Array of LinkV3 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 consultar os discos restantes na próxima consulta. Para obter detalhes, consulte Parâmetros no campo links. |
| 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 |
|---|---|---|
| __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. |
| 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. 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/detail Exemplo de respostas
Código de status: 200
OK
{
"count" : 1,
"volumes" : [ {
"attachments" : [ ],
"availability_zone" : "xxx",
"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/v3/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" : {
"__openstack_region_name" : "pod01.xxx",
"quantityGB" : "1",
"volInfoUrl" : "fusionstorage://172.30.64.10/0/FEFEEB07D3924CDEA93C612D4E16882D"
},
"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",
"service_type" : "EVS",
"wwn" : " 688860300000d136fa16f48f05992360"
} ],
"volumes_links" : [ {
"href" : "https://volume.localdomain.com:8776/v3/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.