Querying Details About a Backup Sharing¶
Function¶
This API is used to query details about a backup sharing.
URI¶
URI format
GET /v2/{project_id}/os-vendor-backup-sharing/{id}
Parameter description
Parameter
Mandatory
Description
project_id
Yes
Project ID
id
Yes
Backup sharing ID
Request¶
None
Response¶
Parameter description
Parameter
Type
Description
shared
dict
Information about the backup sharing
backup_id
string
Backup ID
created_at
string
Creation time of the backup sharing
from_project_id
string
ID of the project that shares the backup
id
string
Backup sharing ID
to_project_id
string
ID of the project to which the backup is shared
updated_at
string
Update time of the backup sharing
backup
dict
Details about the source backup
availability_zone
string
AZ where the backup resides
container
string
Container of the backup
created_at
string
Backup creation time
data_timestamp
string
Current time
description
string
Backup description
fail_reason
string
Cause of the backup failure
has_dependent_backup
boolean
Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.
id
string
Backup ID
is_incremental
boolean
Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.
name
string
Backup name
object_count
int
Number of objects on OBS for the disk data
size
int
Backup size
snapshot_id
string
ID of the snapshot associated with the backup
status
string
Backup status
updated_at
string
Update time of the backup
volume_id
string
Source disk ID of the backup
service_metadata
string
Backup metadata
Example response
{ "shared": { "backup": { "availability_zone": "AZ1", "container": null, "created_at": "2017-08-08T04:03:27.000000", "data_timestamp": "2017-08-08T04:03:27.000000", "description": null, "fail_reason": "Invalid InitiatorConnector protocol specified DSWARE", "has_dependent_backups": null, "id": "066b1e37-9305-4057-97e5-2e99b21fc71d", "is_incremental": null, "name": "lbf", "object_count": 0, "size": 1, "snapshot_id": null, "status": "available", "updated_at": "2017-08-16T07:24:24.786297", "volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10", "service_metadata": null }, "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d", "created_at": "2017-08-22T08:43:16.699374", "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554", "id": "8332443e-9866-41d8-8a58-a898cf5db030", "to_project_id": "722513ed0a324dadaabe5b2d0fe848c9", "updated_at": null } }
Status Codes¶
Normal
200
Abnormal
Status Code
Description
400 Bad Request
The server failed to process the request.
401 Unauthorized
You must enter the username and password to access the requested page.
403 Forbidden
You are forbidden to access the requested page.
404 Not Found
The server could not find the requested page.
405 Method Not Allowed
You are not allowed to use the method specified in the request.
406 Not Acceptable
The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
You must use the proxy server for authentication so that the request can be processed.
408 Request Timeout
The request timed out.
409 Conflict
The request could not be processed due to a conflict.
500 Internal Server Error
Failed to complete the request because of an internal service error.
501 Not Implemented
Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
Failed to complete the request because the request is invalid.
503 Service Unavailable
Failed to complete the request because the service is unavailable.
504 Gateway Timeout
A gateway timeout error occurred.
Error Codes¶
For details, see Error Codes.