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.
Atualizado em 2023-04-26 GMT+08:00

Consulta de um cofre especificado

Função

Esta API é usada para consultar um cofre especificado com base em seu ID.

URI

GET /v3/{project_id}/vaults/{vault_id}

Tabela 1 Parâmetros de caminho

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

Tabela 2 Parâmetros do cabeçalho 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âmetros de resposta

Código de status: 200

Tabela 3 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

vault

Vault object

Objetos retornados após a consulta por um cofre

Tabela 4 Vault

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

Tabela 5 Billing

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 de 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:

  • available
  • lock
  • frozen
  • deleting
  • error

storage_unit

String

Nome do bucket para o cofre

used

Integer

Capacidade utilizada, em MB.

frozen_scene

String

Cenário quando uma conta é congelada

Tabela 6 ResourceResp

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:

  • available
  • error
  • protecting
  • restoring
  • removing

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

Tabela 7 ResourceExtraInfo

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.

Tabela 8 Tag

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 (.).

Tabela 9 VaultBindRules

Parâmetro

Tipo

Descrição

tags

Array of BindRulesTags objects

Filtra recursos associados automaticamente por tag.

Tabela 10 BindRulesTags

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 (_).

Código de status: 404

Tabela 11 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

vault

Vault object

Objetos retornados após a consulta por um cofre

Tabela 12 Vault

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

Tabela 13 Billing

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:

  • available
  • lock
  • frozen
  • deleting
  • error

storage_unit

String

Nome do bucket para o cofre

used

Integer

Capacidade utilizada, em MB.

frozen_scene

String

Cenário quando uma conta é congelada

Tabela 14 ResourceResp

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:

  • available
  • error
  • protecting
  • restoring
  • removing

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

Tabela 15 ResourceExtraInfo

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.

Tabela 16 Tag

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 (.).

Tabela 17 VaultBindRules

Parâmetro

Tipo

Descrição

tags

Array of BindRulesTags objects

Filtra recursos associados automaticamente por tag.

Tabela 18 BindRulesTags

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

GET https://{endpoint}/v3/{project_id}/vaults/{vault_id}

Exemplo de respostas

Código de status: 200

OK

{ "vault" : { "id" : "2b076f26-391f-40fa-bf71-a798940faccf", "name" : "sdk-vault1595581958", "description" : null, "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2020-07-24T09:12:49.491874", "project_id" : "0605767b5780d5762fc5c0118072a564", "enterprise_project_id" : "0", "auto_bind" : true, "bind_rules" : { }, "auto_expand" : false, "user_id" : "aa2999fa5ae640f28926f8fd79188934", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "frozen_scene" : null, "charging_mode" : "post_paid", "order_id" : null, "product_id" : null, "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "storage_unit" : null, "status" : "available", "size" : 40 }, "tags" : [ { "key" : "fds", "value" : null } ] } }

Códigos de status

Código de status

Descrição

200

OK

404

Not Found

Códigos de erro

Consulte Códigos de erro.