Updated on 2025-11-03 GMT+08:00

Querying Share Member Details

Function

This API is used to obtain the details of a backup share member.

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/{member_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

backup_id

Yes

String

Backup ID

member_id

Yes

String

Member ID, which is the project ID of the tenant who receives the shared backup.

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

member

Member object

Response parameters of querying the details of a backup share member

Table 4 Member

Parameter

Type

Description

status

String

Backup sharing status

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. Default value: N/A

For details about how to obtain the backup ID, see Obtaining a 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

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

Example Responses

Status code: 200

OK

{
  "member" : {
    "status" : "accepted",
    "backup_id" : "17c9acd8-3af3-4401-bab9-ff1cfac15561",
    "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0",
    "dest_project_id" : "0761021b8900d2622f38c0115db0b331",
    "created_at" : "2020-02-24T09:36:00.479+00:00",
    "id" : "824a90b3-c562-448b-ab04-60ea4a97cf60"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.