Obtaining the Share Member List

Function

This API is used to obtain the list of members with whom you share the backups.

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

GET /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 A positive integer 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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
dest_project_id	No	String	Definition ID of the project that accepts the shared backup. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
image_id	No	String	Definition ID of the image registered using the accepted shared backup. For details about how to obtain the image ID, see Querying Images. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range A positive integer Default Value N/A
marker	No	String	Definition ID of the last record displayed on the previous page. Constraints N/A Range 32 hexadecimal digits (UUID format) Default Value N/A
offset	No	Integer	Definition Offset. Constraints N/A Range A positive integer Default Value N/A
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	Definition Backup sharing status. Constraints N/A Range pending: pending processing accepted rejected Default Value N/A
vault_id	No	String	Definition ID of the destination vault that stores the accepted shared backup. For details about how to obtain the vault ID, see Querying the Vault List. Constraints N/A Range 32 hexadecimal digits (UUID format) Default Value N/A

Request Parameters

**Table 3** 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

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	Definition Number of backup sharing members. Range An integer greater than or equal to 0

**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

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

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"
  } ],
  "count" : 50
}