Consulta de recursos de cofre

project_id

Sim

String

ID do projeto

without_any_tag

Não

Boolean

Se esse parâmetro for definido como true, todos os recursos sem tags serão consultados. Nesse caso, os campos tag, not_tags, tags_any e not_tags_any são ignorados.

tags

Não

Array of TagsReq objects

Lista de tags incluídas. Os backups com essas tags serão filtrados.

Esta lista não pode ser uma lista vazia.

A lista pode conter até 10 chaves.

As chaves nesta lista devem ser exclusivas.

A resposta retorna recursos que não contêm quaisquer tags nesta lista. As chaves nesta lista estão em uma relação AND, enquanto os valores em cada estrutura key-value estão em uma relação OR.

Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

tags_any

Não

Array of TagsReq objects

Lista de tags. Backups com qualquer tag nesta lista serão filtrados.

Esta lista não pode ser uma lista vazia.

A lista pode conter até 10 chaves.

As chaves nesta lista devem ser exclusivas.

A resposta retorna recursos que não contêm quaisquer tags nesta lista. As chaves nesta lista estão em uma relação OR, enquanto os valores em cada estrutura key-value estão em uma relação OR.

Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

not_tags

Não

Array of TagsReq objects

Lista de tags excluídas. Backups sem essas tags serão filtrados.

Esta lista não pode ser uma lista vazia.

A lista pode conter até 10 chaves.

As chaves nesta lista devem ser exclusivas.

A resposta retorna recursos que não contêm tags nesta lista. As chaves nesta lista estão em uma relação AND, enquanto os valores em cada estrutura key-value estão em uma relação OR.

Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

not_tags_any

Não

Array of TagsReq objects

Lista de tags. Backups sem nenhuma tag nesta lista serão filtrados.

Esta lista não pode ser uma lista vazia.

A lista pode conter até 10 chaves.

As chaves nesta lista devem ser exclusivas.

A resposta retorna recursos sem nenhuma tag nesta lista. As chaves nesta lista estão em uma relação OR, enquanto os valores em cada estrutura key-value estão em uma relação OR.

Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

sys_tags

Não

Array of SysTags objects

Somente usuários com a permissão op_service podem usar esse campo para filtrar recursos.

Atualmente, as chamadas do TMS podem somente uma estrutura da tag.

key: _sys_enterprise_project_id

values: lista de IDs de projeto empresarial

Atualmente, key contém apenas um valor. 0 indica o projeto empresarial padrão.

As condições de filtragem de sys_tags e de tag de locatário (tags, tags_any, not_tags e not_tags_any) não podem ser usadas ao mesmo tempo.

Se não houver sys_tags, use outras APIs de tags para filtragem. Se nenhuma condição de filtragem de tag for especificada, os dados completos serão retornados.

Esta lista não pode ser uma lista vazia.

limit

Não

String

Contagem de consultas. (Este parâmetro não é exibido quando action é definida como count.) Se a ação estiver definida como filter, o valor padrão será 1000. O valor varia de 1 a 1000. Se você definir um valor que não esteja dentro desse intervalo, um erro será relatado. O número de registros retornados não pode exceder o valor de limite.

offset

Não

String

Posição do índice. (Este parâmetro não é exibido quando action é definida como count.) Se action for definida como filter, o valor padrão será 0 e o valor mínimo de offset será 0. O primeiro registro no resultado da consulta é o registro offset+1 que atende aos critérios da consulta.

action

Sim

String

Identificador da operação. Os valores possíveis são filter e count. O valor de filter indica consulta de paginação. O valor de count indica que o número total de resultados de consulta que atendem aos critérios de pesquisa será retornado.

matches

Não

Array of Match objects

Critérios de pesquisa suportados por recursos

As chaves nesta lista devem ser exclusivas.

Apenas uma chave é suportada atualmente. O suporte a várias chaves estará disponível posteriormente.

cloud_type

Não

String

Tipo de nuvem

Valores de enumeração:

• public
• hybrid

object_type

Não

String

Tipo de recurso

Valores de enumeração:

• server
• disk

key

Sim

String

Chave

Contém um máximo de 127 caracteres Unicode.

Uma chave de tag não pode ser uma cadeia vazia.

Espaços antes e depois de uma chave serão descartados.

values

Sim

Array of strings

Lista de valores

A lista pode conter até 10 valores.

Um valor de tag contém até 255 caracteres Unicode. Espaços antes e depois de uma chave serão descartados.

Os valores nesta lista devem ser exclusivos.

Os valores nesta lista estão em uma relação OR.

Essa lista pode estar vazia e cada valor pode ser uma cadeia de caracteres vazia.

Se esta lista for deixada em branco, indica que todos os valores estão incluídos.

O asterisco (*) é um caractere reservado no sistema. Se o valor começar com *, indica que a correspondência difusa é executada com base no valor seguinte a *. O valor não pode conter apenas asteriscos.

key

Sim

String

Chave. Chave da tag do sistema, que é obtida da lista branca e não pode ser definida aleatoriamente. Atualmente, apenas o campo _sys_enterprise_project_id é suportado e o value correspondente indica o ID do projeto empresarial.

values

Sim

Array of strings

Lista de valores. Atualmente, apenas o ID do projeto empresarial é usado. O ID de projeto empresarial padrão é 0.

key

Sim

String

Chave. Uma chave só pode ser definida como resource_name, indicando o nome do recurso.

value

Sim

String

Valor. Um valor consiste em até 255 caracteres. Se key for definido como resource_name, uma cadeia de caracteres vazia indica correspondência exata e qualquer cadeia de caracteres não vazia indica correspondência difusa.

resources

Array of TagResource objects

Lista de recursos correspondentes (Esse parâmetro não será exibido se a action estiver definida como count.)

total_count

Integer

Número total de recursos correspondentes

resource_id

String

ID do recurso

resource_detail

Array of Vault objects

Detalhes do recurso

tags

Array of Tag objects

Lista de tags Se não houver tag, uma matriz vazia é usada por padrão.

resource_name

String

Nome do recurso

sys_tags

Array of SysTag objects

Somente usuários com a permissão op_service podem obter esse campo.

Atualmente, apenas resource_tag está incluída.

key: _sys_enterprise_project_id

value: ID do projeto empresarial. Valor 0 indica o projeto empresarial padrão.

Esse campo não é retornado no cenário non-op_service.

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

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

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

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.

tags

Array of BindRulesTags objects

Filtra recursos associados automaticamente por tag.

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

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

key

String

Chave. Chave da tag do sistema, que é obtida da lista branca e não pode ser definida aleatoriamente. Atualmente, apenas o campo _sys_enterprise_project_id é suportado e o value correspondente indica o ID do projeto empresarial.

value

String

Valor. Atualmente, somente o ID do projeto empresarial é usado. O ID de projeto empresarial padrão é 0.

error_code

String

Para obter detalhes, consulte Códigos de erro.

error_msg

String

Mensagem de erro

200

OK

400

Bad Request