Adding a Share Member

Function

This API 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.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
backup_id	Yes	String	Definition Backup ID. For details about how to obtain the backup ID, see Querying All Backups. Constraints N/A Range 32 hexadecimal digits (UUID format) Default Value N/A
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
members	No	Array of strings	Definition Project IDs of the backup sharing members to be added. Constraints N/A Range 1 to 10 project IDs. For details about how to obtain the project ID, see Obtaining a Project ID. Default Value N/A
domains	No	Array of strings	Definition Domain IDs of the backup sharing members to be added. Constraints N/A Range N/A Default Value N/A NOTE: This feature is in the open beta test (OBT) phase and may be unavailable in some regions.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
members	Array of Member objects	Response of adding backup sharing members

**Table 5** Member
Parameter	Type	Description
status	String	Definition Sharing status. Range pending: pending processing 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	Definition Backup ID. Range N/A
image_id	String	Definition ID of the image created from the accepted shared backup. Range N/A
dest_project_id	String	Definition ID of the project that accepts the shared backup. Range N/A
vault_id	String	Definition ID of the vault where the accepted shared backup is stored. Range N/A
id	String	Definition Sharing record ID. Range N/A

Example Requests

Add a member 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"
  } ]
}