Obtaining the Share Member List

Function

This API is used to obtain the list of backup share members.

URI

GET /v3/{project_id}/backups/{backup_id}/members

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
backup_id	Yes	String	Backup ID
project_id	Yes	String	Project ID

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
dest_project_id	No	String	ID of the project with which the backup is shared
image_id	No	String	ID of the image created from the accepted backup
limit	No	Integer	Number of records displayed per page. The value must be a positive integer.
marker	No	String	ID of the last record displayed on the previous page. Only UUID is supported.
offset	No	Integer	Offset value, which is a positive integer.
sort	No	String	A group of properties separated by commas (,) and sorting directions. The value is in the format of <key1>[:<direction>],<key2>[:<direction>], where the value of direction is asc (ascending order) or desc (descending order). If a direction is not specified, the default sorting direction is desc. The value of sort can contain a maximum of 255 characters.
status	No	String	Status of a shared backup
vault_id	No	String	ID of the vault where the shared backup is stored. Only UUID is supported.

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
members	Array of Member objects	Response parameters of adding a backup share member
count	Integer	Number of share members that the backup is shared to

Table 5 Member

Parameter	Type	Description
status	String	Backup sharing status Enumeration values: pending accepted rejected
created_at	String	Backup sharing time, for example, 2020-02-05T10:38:34.209782
updated_at	String	Update time, for example, 2020-02-05T10:38:34.209782
backup_id	String	Backup ID
image_id	String	ID of the image created by using the accepted shared backup
dest_project_id	String	ID of the project with which the backup is shared
vault_id	String	ID of the vault where the shared backup is stored
id	String	ID of the shared record

Example Requests

GET  https://{endpoint}/v3/{project_id}/backups/{backup_id}/members

Example Responses

Status code: 200

OK

{
  "members" : [ {
    "status" : "pending",
    "backup_id" : "0b07081e-3ec7-4e77-8571-54e2947da422",
    "dest_project_id" : "075e6035d300d48c2fd0c00b78b71ebf",
    "created_at" : "2020-02-05T10:38:34.210+00:00",
    "id" : "3c5a3015-c3a0-4dc6-a1e2-917b90f62319"
  } ],
  "count" : 50
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

last updated: 2024-11-13 13:44 UTC - commit: bd2d1958eaead4a18cca4ca43ac601bab2a34dcb