Atualização de um disco EVS
Função
Esta API é usada para atualizar um disco EVS.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
PUT /v3/{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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| volume | Sim | CinderUpdateVolumeOption object | As informações do disco a serem atualizadas. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Não | String | O nome do disco. Você pode inserir até 64 caracteres. |
| description | Não | String | A descrição do disco. Você pode inserir até 85 caracteres. |
| metadata | Não | Map<String,String> | Os metadados do disco. O comprimento de key e value em metadata não pode conter mais de 255 bytes. |
| display_description | Não | String | A descrição do disco. Você pode especificar o parâmetro description ou display_description. Se ambos forem especificados, o valor de description será usado. Você pode inserir até 85 caracteres. |
| display_name | Não | String | O nome do disco. Você pode especificar name ou display_name. Se ambos forem especificados, o valor de name será usado. Você pode inserir até 64 caracteres. |
Parâmetros de resposta
Código de status: 200
| 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 | As informações do anexo. |
| 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. |
| 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 |
| description | String | A descrição do disco. |
| volume_type | String | O tipo de disco. O valor pode ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 ou ESSD2.
|
| replication_status | String | O campo reservado. |
| consistencygroup_id | String | O ID do grupo de consistência ao qual o disco pertence. |
| source_volid | String | O ID do disco de origem. Este campo não é suportado no momento. |
| snapshot_id | String | O ID do snapshot. |
| metadata | VolumeMetadata object | Os metadados. |
| size | Integer | O tamanho do disco, em GiB. |
| user_id | String | O ID do usuário que usa o disco. |
| updated_at | String | A hora em que o disco foi atualizado. |
| shareable | Boolean | Se o disco é compartilhável. Observação: este campo foi preterido. Use multiattach. |
| multiattach | Boolean | Se o disco é compartilhável. true: o disco é compartilhável. false: o disco não pode ser compartilhado. |
| storage_cluster_id | String | 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. |
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
PUT https://{endpoint}/v3/{project_id}/volumes/{volume_id}
{
"volume" : {
"name" : "test_volume",
"description" : "test"
}
} Exemplo de respostas
Código de status: 200
OK
{
"volume" : {
"attachments" : [ ],
"availability_zone" : "az-dc-1",
"bootable" : "false",
"consistencygroup_id" : null,
"created_at" : "2016-05-25T02:38:40.392463",
"description" : "create for api test",
"encrypted" : false,
"id" : "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel" : "bookmark"
} ],
"metadata" : {
"volume_owner" : "openapi"
},
"name" : "openapi_vol01",
"replication_status" : "disabled",
"multiattach" : false,
"size" : 40,
"snapshot_id" : null,
"source_volid" : null,
"status" : "creating",
"updated_at" : null,
"user_id" : "39f6696ae23740708d0f358a253c2637",
"volume_type" : "SATA"
}
} 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.