Modificação de um cofre
Função
Esta API é usada para modificar um cofre com base em seu ID.
URI
PUT /v3/{project_id}/vaults/{vault_id}
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | ID do projeto |
vault_id | Sim | String | ID do cofre |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Token de usuário. O token 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 |
|---|---|---|---|
vault | Sim | VaultUpdate object | Corpo da solicitação de modificar um cofre |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
billing | Não | BillingUpdate object | Informações da cobrança |
name | Não | String | Nome do cofre Mínimo: 1 Máximo: 64 |
auto_bind | Não | Boolean | Se a associação automática é suportada |
bind_rules | Não | VaultBindRules object | Regras de associação |
auto_expand | Não | Boolean | Se ativar a expansão de capacidade automática para o cofre. Somente os cofres do pagamento por uso suportam a autoexpansão da capacidade. |
smn_notify | Não | Boolean | Função de notificação de exceção Padrão: true |
threshold | Não | Integer | Limite de capacidade do cofre. Se o uso da capacidade do cofre exceder este limite e smn_notify for ativada, uma notificação de exceção será enviada. Mínimo: 1 Máximo: 100 Padrão: 80 |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
consistent_level | Não | String | Especificações do cofre Valores de enumeração:
|
size | Não | Integer | Tamanho do cofre, em GB Mínimo: 1 Máximo: 10485760 |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
tags | Não | Array of BindRulesTags objects | Filtra recursos associados automaticamente por tag. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
key | Sim | String | A chave não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ A chave pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
value | Sim | String | O valor não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ O valor pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
vault | Vault object | Objetos retornados após a consulta por um cofre |
Parâmetro | Tipo | Descrição |
|---|---|---|
billing | Billing object | Informação da operação |
description | String | Descrição do cofre definida pelo usuário Mínimo: 0 Máximo: 255 |
id | String | ID do cofre |
name | String | Nome do cofre Mínimo: 1 Máximo: 64 |
project_id | String | ID do projeto |
provider_id | String | ID do tipo de recurso do cofre |
resources | Array of ResourceResp objects | Recursos do cofre |
tags | Array of Tag objects | Tags do cofre |
enterprise_project_id | String | ID do projeto empresarial. O valor padrão é 0. |
auto_bind | Boolean | Indica se a associação automática está ativada. Seu valor padrão é false (não ativado). |
bind_rules | VaultBindRules object | Regra de associação |
user_id | String | ID do usuário |
created_at | String | Tempo de criação, por exemplo, 2020-02-05T10:38:34.209782 |
auto_expand | Boolean | Se ativar a expansão de capacidade automática para o cofre. Somente os cofres do pagamento por uso suportam a autoexpansão da capacidade. |
smn_notify | Boolean | Função de notificação de exceção Padrão: true |
threshold | Integer | Limite de capacidade do cofre. Se o uso da capacidade do cofre excede este limite, uma notificação de exceção é enviada. Mínimo: 1 Máximo: 100 Padrão: 80 |
Parâmetro | Tipo | Descrição |
|---|---|---|
allocated | Integer | Capacidade alocada, em GB. |
charging_mode | String | Modo de cobrança, que pode ser post_paid (pagamento por uso) ou pre_paid (anual/mensal). O valor padrão é post_paid. |
cloud_type | String | Tipo de nuvem, que pode ser public ou hybrid |
consistent_level | String | Especificação do cofre, que pode ser crash_consistent (backup consistente com falhas) ou app_consistent (backup consistente com a aplicação) |
object_type | String | Tipo de objeto, que pode ser server, disk, turbo ou workspace |
order_id | String | ID do pedido |
product_id | String | ID do produto |
protect_type | String | Tipo de proteção, que pode ser backup ou replication |
size | Integer | Capacidade, em GB Mínimo: 1 Máximo: 10485760 |
spec_code | String | Código de especificação. Cofre de backup do servidor: vault.backup.server.normal; Cofre de backup em disco: vault.backup.volume.normal; Cofre de backup do sistema de arquivos: vault.backup.turbo.normal |
status | String | Estado do cofre Valores de enumeração:
|
storage_unit | String | Nome do bucket para o cofre |
used | Integer | Capacidade utilizada, em MB. |
frozen_scene | String | Cenário quando uma conta é congelada |
Parâmetro | Tipo | Descrição |
|---|---|---|
extra_info | ResourceExtraInfo object | Informações adicionais do recurso |
id | String | ID do recurso a ser copiado |
name | String | Nome do recurso a ser copiado Mínimo: 0 Máximo: 255 |
protect_status | String | Status da proteção Valores de enumeração:
|
size | Integer | Capacidade alocada para os recursos associados, em GB |
type | String | Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2 |
backup_size | Integer | Tamanho do backup |
backup_count | Integer | Número de backups |
Parâmetro | Tipo | Descrição |
|---|---|---|
exclude_volumes | Array of strings | IDs dos discos dos quais não será feito backup. Este parâmetro é usado quando os servidores são adicionados a um cofre, que inclui todos os discos do servidor. Mas alguns discos não precisam ser copiados. Ou no caso de um servidor ter sido adicionado anteriormente e alguns discos neste servidor não precisarem ser copiados. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | Chave Pode conter no máximo 36 caracteres. Não pode ser uma cadeia vazia. Espaços antes e depois de uma chave serão descartados. Não pode conter os seguintes caracteres: ASCII (0-31), sinais de igual (=), asteriscos (*), parênteses angulares esquerdos (<), parênteses angulares direitos (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/). Pode conter apenas caracteres chineses, letras, dígitos, hifens (-) e sublinhados (_). |
value | String | Valor É obrigatório quando uma tag é adicionada e opcional quando uma tag é excluída. Pode conter no máximo 43 caracteres. Pode ser uma cadeia vazia. Espaços antes e depois de um valor serão descartados. Não pode conter os seguintes caracteres: ASCII (0-31), sinais de igual (=), asteriscos (*), parênteses angulares esquerdos (<), parênteses angulares direitos (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/). Pode conter apenas caracteres chineses, letras, dígitos, hifens (-), sublinhados (_), e pontos (.). |
Parâmetro | Tipo | Descrição |
|---|---|---|
tags | Array of BindRulesTags objects | Filtra recursos associados automaticamente por tag. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | A chave não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ A chave pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
value | String | O valor não pode conter caracteres ASCII não imprimíveis (0–31) ou os seguintes caracteres: =*<>,|/ O valor pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). |
Exemplo de solicitações
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d
{
"vault" : {
"billing" : {
"size" : 200
},
"name" : "vault_name02"
}
} Exemplo de respostas
Código de status: 200
OK
{
"vault" : {
"name" : "vault_name02",
"billing" : {
"status" : "available",
"used" : 0,
"protect_type" : "backup",
"order_id" : null,
"object_type" : "server",
"allocated" : 40,
"spec_code" : "vault.backup.server.normal",
"size" : 200,
"cloud_type" : "public",
"product_id" : null,
"consistent_level" : "crash_consistent",
"storage_unit" : null,
"charging_mode" : "post_paid"
},
"tags" : [ {
"value" : "value01",
"key" : "key01"
} ],
"created_at" : "2019-05-08T09:31:21.840431",
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
"enterprise_project_id" : "0",
"id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8",
"resources" : [ {
"name" : "ecs-1f0f-0003",
"protect_status" : "available",
"extra_info" : {
"exclude_volumes" : [ "bdef09bb-293f-446a-88a4-86e9f14408c4" ]
},
"type" : "OS::Nova::Server",
"id" : "97595625-198e-4e4d-879b-9d53f68ba551",
"size" : 40
} ],
"description" : "vault_description"
}
} Códigos de status
Código de status | Descrição |
|---|---|
200 | OK |
Códigos de erro
Consulte Códigos de erro.

