文档首页/ 云备份 CBR/ API参考/ API/ 项目/ 查询租户的项目信息
更新时间:2024-06-20 GMT+08:00
分享

查询租户的项目信息

功能介绍

查询租户的企业项目信息

接口约束

本接口仅用于开通了企业项目场景中,Console需要获取复制目标区域的project_id时使用,其它场景下调用无返回值。

调用方法

请参见如何调用API

URI

GET /v3/region-projects

请求参数

响应参数

状态码: 200

表1 响应Body参数

参数

参数类型

描述

projects

Array of ProjectsListInfo objects

项目信息

links

SelfLinksInfo object

连接地址

表2 ProjectsListInfo

参数

参数类型

描述

domain_id

String

域 ID

is_domain

Boolean

是否是域级

parent_id

String

父项目 ID

name

String

名称

description

String

描述信息

id

String

项目ID

enabled

Boolean

是否开启

links

SelfLinksInfo object

连接地址

表3 SelfLinksInfo

参数

参数类型

描述

self

String

连接地址

请求示例

GET https://{endpoint}/v3/region-projects

响应示例

状态码: 200

OK

{
  "projects" : [ {
    "description" : "",
    "domain_id" : "5ba348512fd541c3a57c9bb2196108f8",
    "enabled" : true,
    "id" : "45a3afcc926f47d08b9375694b062193",
    "is_domain" : false,
    "links" : {
      "self" : "https://iam.huaweicloud.com:31943/v3/projects/45a3afcc926f47d08b9375694b062193"
    },
    "name" : "cn-hk1_yyx2",
    "parent_id" : ""
  }, {
    "description" : "",
    "domain_id" : "5ba348512fd541c3a57c9bb2196108f8",
    "enabled" : true,
    "id" : "438fe051ccb04aeabc0c8112a276a0dc",
    "is_domain" : false,
    "links" : {
      "self" : "https://iam.huaweicloud.com:31943/v3/projects/438fe051ccb04aeabc0c8112a276a0dc"
    },
    "name" : "cn-xianhz-1",
    "parent_id" : ""
  } ],
  "links" : {
    "self" : "https://iam.huaweicloud.com:31943/v3/auth/projects"
  }
}

SDK代码示例

SDK代码示例如下。

Java

 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
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 ListProjectsSolution {

    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();
        ListProjectsRequest request = new ListProjectsRequest();
        try {
            ListProjectsResponse response = client.listProjects(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());
        }
    }
}

Python

 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
# 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 = ListProjectsRequest()
        response = client.list_projects(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
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.ListProjectsRequest{}
	response, err := client.ListProjects(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档