Consulta de snapshots do EVS
Função
Consultar snapshots do EVS
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v3/{project_id}/snapshots
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. |
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. |
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. |
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?limit=50; consultar 51–100 snapshots: GET /v2/xxx/snapshots?offset=50&limit=50 |
name | Não | String | O nome do snapshot. Este parâmetro não suporta correspondência difusa. Você pode inserir até 255 caracteres. |
status | Não | String | O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS. |
volume_id | Não | String | O ID do disco de origem do snapshot. |
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âmetros de resposta
Código de status: 200
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 SnapshotSummary objects | As informações do snapshot. |
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 |
|---|---|---|
created_at | String | A hora em que o snapshot foi criado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
description | String | A descrição do snapshot. |
id | String | O ID do snapshot. |
metadata | Map<String,String> | Os metadados do snapshot. Se metadata contiverem o campo __system__enableActive, o snapshot será um snapshot gerado automaticamente durante um backup do servidor. |
name | String | O nome do snapshot. |
size | Integer | O tamanho do snapshot, em GiB. |
status | String | O status do snapshot. Para obter detalhes, consulte Status do snapshot do EVS. |
updated_at | String | A hora em que o snapshot foi atualizado. Formato da hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX |
volume_id | String | O ID do disco de origem do snapshot. |
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
GET https://{endpoint}/v3/{project_id}/snapshots?status=available Exemplo de respostas
Código de status: 200
OK
{
"snapshots" : [ {
"created_at" : "2016-02-16T16:54:14.981520",
"description" : null,
"id" : "b836dc3d-4e10-4ea4-a34c-8f6b0460a583",
"metadata" : { },
"name" : "test01",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:19.475397",
"description" : null,
"id" : "83be494d-329e-4a78-8ac5-9af900f48b95",
"metadata" : { },
"name" : "test02",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:24.367414",
"description" : null,
"id" : "dd360f46-7593-4d35-8f2c-5566fd0bd79e",
"metadata" : { },
"name" : "test03",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
}, {
"created_at" : "2016-02-16T16:54:29.766740",
"description" : null,
"id" : "4c29796a-8cf4-4482-9afc-e66da9a81240",
"metadata" : { },
"name" : "test04",
"size" : 1,
"status" : "available",
"volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209",
"updated_at" : null
} ],
"snapshots_links" : 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.

