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.
Central de ajuda/Elastic Volume Service/Referência de API/APIs desatualizadas/API Cinder/Gerenciamento de snapshots/Consulta de detalhes sobre snapshots do EVS
Atualizado em 2024-09-25 GMT+08:00
Ver PDF
Compartilhar

Consulta de detalhes sobre snapshots do EVS

Função

Esta API é usada para consultar detalhes sobre os snapshots do EVS.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v3/{project_id}/snapshots/detail

Tabela 1 Parâmetros de caminho

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.

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

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.

volume_id

Não

String

O ID do disco de origem do snapshot.

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.

Se o locatário tiver mais de 50 snapshots no total, é recomendável usar esse parâmetro e definir seu valor como 50 para melhorar a eficiência da consulta. Os exemplos são fornecidos como a seguir:

Consultar 1–50 snapshots: GET /v2/xxx/snapshots/detail?limit=50; consultar 51–100 snapshots: GET /v2/xxx/snapshots/detail?offset=50&limit=50

name

Não

String

O nome do snapshot. Você pode inserir até 255 caracteres.

offset

Não

Integer

O deslocamento.

NOTA:

Observação: esse parâmetro é usado quando snapshots são consultados por página e é usado em conjunto com o parâmetro limit. Por exemplo, há um total de 30 snapshots. Se você definir offset para 11 e limit para 10, a consulta começará a partir do décimo segundo snapshot e um máximo de 10 snapshots poderão ser consultados por vez.

status

Não

String

O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS.

Parâmetros de solicitação

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

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

snapshots_links

Array of Link objects

O marcador de posição da consulta na lista de snapshots. Esse campo é retornado somente quando limit é especificado na solicitação, e esse campo indica que apenas alguns snapshots são retornados nessa consulta.

snapshots

Array of SnapshotDetail objects

As informações do snapshot.

Tabela 5 Link

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

Tabela 6 SnapshotDetail

Parâmetro

Tipo

Descrição

id

String

O ID do snapshot.

name

String

O nome do snapshot.

Snapshots cujos nomes começam com o prefixo autobk_snapshot_ são criados automaticamente pelo sistema quando os backups são criados. Esses snapshots não podem ser excluídos ou usados para reverter dados.

description

String

A descrição do snapshot.

created_at

String

A hora em que o snapshot foi criado.

Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX

updated_at

String

A hora em que o snapshot foi atualizado.

metadata

Map<String,String>

Os metadados do snapshot.

volume_id

String

O ID do disco de origem do snapshot.

size

String

O tamanho do snapshot, em GiB.

status

String

O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS.

os-extended-snapshot-attributes:progress

String

O campo reservado.

os-extended-snapshot-attributes:project_id

String

O ID do locatário. O ID do locatário é o mesmo que o ID do projeto.

Código de status: 400

Tabela 7 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error

Error object

A mensagem de erro retornada se ocorrer um erro.

Tabela 8 Error

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

GET https://{endpoint}/v3/{project_id}/snapshots/detail?status=available

Exemplo de respostas

Código de status: 200

OK

{
  "snapshots": [
    {
      "status": "available",
      "os-extended-snapshot-attributes:progress": "100%",
      "description": null,
      "created_at": "2013-06-19T07:15:29.000000",
      "metadata": {},
      "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
      "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
      "size": 5,
      "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa",
      "name": "name_xx2-snap",
      "updated_at": null,
    },
    {
      "status": "available",
      "os-extended-snapshot-attributes:progress": "100%",
      "description": null,
      "created_at": "2013-06-19T09:08:08.000000",
      "metadata": {},
      "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d",
      "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561",
      "size": 5,
      "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f",
      "name": "name_xx2-snap",
      "updated_at": null,
    }
  ]
}

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.

Tópico principal:Gerenciamento de snapshots