文档首页> 云备份 CBR> API参考> API> 备份共享> 获取备份成员列表
更新时间:2024-03-12 GMT+08:00
分享

获取备份成员列表

功能介绍

获取备份共享成员的列表信息

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

backup_id

String

备份id

project_id

String

项目id

表2 Query参数

参数

是否必选

参数类型

描述

dest_project_id

String

接受备份共享的项目id

image_id

String

接受的共享备份副本注册的镜像id

limit

Integer

每页显示的条目数量,正整数

marker

String

上一次查询最后一条的id,仅支持uuid

offset

Integer

偏移值,正整数

sort

String

sort的内容为一组由逗号分隔的属性及可选排序方向组成,形如<key1>[:<direction>],<key2>[:<direction>],其中direction的取值为asc (升序) 或 desc (降序),如没有传入direction参数,默认为降序,sort内容的长度限制为255个字符。

status

String

备份共享状态

vault_id

String

目标端接受共享备份的存储库id,仅支持uuid

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

members

Array of Member objects

添加备份共享成员响应信息

count

Integer

备份共享成员数量

表5 Member

参数

参数类型

描述

status

String

共享状态

  • pending: 等待处理

  • accepted: 已接收

  • rejected: 已拒绝

created_at

String

共享时间,例如:"2020-02-05T10:38:34.209782"

updated_at

String

更新时间,例如:"2020-02-05T10:38:34.209782"

backup_id

String

备份副本id

image_id

String

接受的共享备份副本注册的镜像id

dest_project_id

String

接受备份共享的项目id

vault_id

String

目标端接受共享备份的存储库id

id

String

共享记录id

请求示例

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

响应示例

状态码: 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
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cbr.v1.region.CbrRegion;
import com.huaweicloud.sdk.cbr.v1.*;
import com.huaweicloud.sdk.cbr.v1.model.*;


public class ShowMembersDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CbrClient client = CbrClient.newBuilder()
                .withCredential(auth)
                .withRegion(CbrRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowMembersDetailRequest request = new ShowMembersDetailRequest();
        request.withDestProjectId("<dest_project_id>");
        request.withImageId("<image_id>");
        request.withStatus("<status>");
        request.withVaultId("<vault_id>");
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withOffset(<offset>);
        request.withSort("<sort>");
        try {
            ShowMembersDetailResponse response = client.showMembersDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcbr.v1.region.cbr_region import CbrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcbr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = CbrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CbrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowMembersDetailRequest()
        request.dest_project_id = "<dest_project_id>"
        request.image_id = "<image_id>"
        request.status = "<status>"
        request.vault_id = "<vault_id>"
        request.limit = <limit>
        request.marker = "<marker>"
        request.offset = <offset>
        request.sort = "<sort>"
        response = client.show_members_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cbr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cbr.NewCbrClient(
        cbr.CbrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowMembersDetailRequest{}
	destProjectIdRequest:= "<dest_project_id>"
	request.DestProjectId = &destProjectIdRequest
	imageIdRequest:= "<image_id>"
	request.ImageId = &imageIdRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	vaultIdRequest:= "<vault_id>"
	request.VaultId = &vaultIdRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	sortRequest:= "<sort>"
	request.Sort = &sortRequest
	response, err := client.ShowMembersDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品