Adding a Share Member

Function

This interface is used to add members who can share a backup. Only ECS and VBS backups can be shared. Backups can be shared among different projects or users.

URI

POST /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

Request Parameters

Table 2 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.

Table 3 Request body parameters
Parameter	Mandatory	Type	Description
members	Yes	Array of strings	Project IDs of the backup share members to be added Array Length: 1 - 10

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 from the accepted 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

Adding members with whom the backup is shared

POST https://{endpoint}/v3/0605767b5780d5762fc5c0118072a564/backups/0b07081e-3ec7-4e77-8571-54e2947da422/members

{
  "members" : [ "075e6035d300d48c2fd0c00b78b71ebf" ]
}

Example Responses

Status code: 200

{
  "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"
  } ]
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Backup Sharing

Предыдущая статья

Backup Sharing

Следующая статья

Updating the Share Member Status

Была ли эта статья полезна?

Поддержка Юридические документы