更新时间:2024-07-04 GMT+08:00
分享

获取空间列表

功能介绍

功能描述:用户可以使用该接口获取空间列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/league-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id,最大32位,字母和数字组成

最小长度:0

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页记录数,取值0-100

最小值:0

最大值:100

缺省值:10

offset

Integer

记录数偏移量

最小值:0

最大值:2147483647

缺省值:0

type

String

查询的空间类型,owned:创建者,participativenormal:参与者

枚举值:

  • owned

  • participativenormal

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户凭证

Content-Type

String

消息体的类型(格式)

缺省值:application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

lists

Array of TicsLeagueListVo objects

实例集合

total

Long

总记录数

表5 TicsLeagueListVo

参数

参数类型

描述

bcs_channel_name

String

BCS通道名称

最小长度:0

最大长度:128

bcs_ip

String

BCS浏览器ip

最小长度:0

最大长度:128

bcs_org_name

String

BCS组织名称

最小长度:0

最大长度:128

block_chain_id

String

BCS服务实例ID

最小长度:0

最大长度:64

block_chain_name

String

BCS服务实例名称

最小长度:0

最大长度:128

create_date

String

创建日期

create_time

Long

创建时间

creator_id

String

创建人id

最小长度:0

最大长度:32

creator_name

String

创建人名称

最小长度:0

最大长度:128

expire_time

Long

过期时间

id

String

空间id

最小长度:0

最大长度:32

league_status

String

空间状态,CREATING创建中,CREATE_FAILED创建失败,NORMAL正常,UPDATING升级中,UPDATE_FAILED升级失败,ROLLING回滚中,ROLL_FAILED回滚失败,DELETING删除中,DELETE_FAILED删除失败,DELETED已删除

最小长度:0

最大长度:32

枚举值:

  • CREATE_FAILED

  • CREATING

  • DELETED

  • DELETE_FAILED

  • DELETING

  • NORMAL

  • ROLLING

  • ROLL_FAILED

  • UPDATE_FAILED

  • UPDATING

name

String

空间名称

最小长度:0

最大长度:128

partners

Long

空间成员数

type

String

参与类型。OWNER所有者,PARTNER参与者

枚举值:

  • OWNER

  • PARTNER

version

String

空间版本

最小长度:0

最大长度:128

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取节点列表信息

get /v1/{project_id}/league-info?type=owned&limit=10&offset=0

响应示例

状态码: 200

OK

{
  "total" : 1,
  "lists" : [ {
    "id" : "ef73b252a0ad4b5db21a12c40a413b2f",
    "name" : "test",
    "partners" : 3,
    "league_status" : "NORMAL",
    "type" : "OWNER",
    "creator_id" : "098593b08f00d2a34f64c004408b64bc",
    "creator_name" : "user01",
    "create_time" : 1665215103413,
    "create_date" : "2022-10-08T07:45:03.413+00:00",
    "expire_time" : 0,
    "version" : "1.15.1"
  } ]
}

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
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.tics.v1.region.TicsRegion;
import com.huaweicloud.sdk.tics.v1.*;
import com.huaweicloud.sdk.tics.v1.model.*;


public class ListLeaguesSolution {

    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);

        TicsClient client = TicsClient.newBuilder()
                .withCredential(auth)
                .withRegion(TicsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListLeaguesRequest request = new ListLeaguesRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withType(ListLeaguesRequest.TypeEnum.fromValue("<type>"));
        try {
            ListLeaguesResponse response = client.listLeagues(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdktics.v1.region.tics_region import TicsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktics.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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListLeaguesRequest()
        request.limit = <limit>
        request.offset = <offset>
        request.type = "<type>"
        response = client.list_leagues(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    tics "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tics/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 := tics.NewTicsClient(
        tics.TicsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListLeaguesRequest{}
	request.Limit = int32(<limit>)
	request.Offset = int32(<offset>)
	request.Type = model.GetListLeaguesRequestTypeEnum().<TYPE>
	response, err := client.ListLeagues(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

500

获取节点列表失败

分享:

    相关文档

    相关产品