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

获取计算节点列表

功能介绍

功能描述:用户可以使用该接口获取可信节点信息列表。支持节点名称与空间名称的模糊查询。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/agents

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:0

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页记录数,取值0-100

最小值:0

最大值:100

缺省值:10

offset

Integer

记录数偏移量

最小值:0

最大值:2147483647

缺省值:0

agent_name

String

可信节点名称

league_name

String

空间名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户凭证

Content-Type

String

消息体的类型(格式)

缺省值:application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

lists

Array of AgentListVo objects

实例集合

total

Long

总记录数

表5 AgentListVo

参数

参数类型

描述

agent_id

String

可信节点id

agent_name

String

可信节点名称

create_time

String

创建时间

creator_domain_id

String

创建者租户id

creator_user_name

String

创建者名称

deploy_status

String

部署状态:ABNORMAL正常,RESTARTING重启中,RESTART_FAILED重启失败,ROLLBACKING回滚中,STARTING启动中,DEPLOYING创建中,DEPLOY_FAILED创建失败,DEPLOY_SUCCESS创建成功,RUNNING运行中,DELETING删除中,DELETE_FAILED删除失败,DELETE_SUCCESS删除成功,UPGRADING升级中,UPGRADE_FAILED升级失败,ROLLBACK回退中,ROLLBACK_FAILED回退失败,SUCCESS成功,FAILED失败,TO_START待开始,IN_PROGRESS进行中

枚举值:

  • ABNORMAL

  • DELETE_FAILED

  • DELETE_SUCCESS

  • DELETING

  • DEPLOYING

  • DEPLOY_FAILED

  • DEPLOY_SUCCESS

  • FAILED

  • IN_PROGRESS

  • RESTARTING

  • RESTART_FAILED

  • ROLLBACK

  • ROLLBACKING

  • ROLLBACK_FAILED

  • RUNNING

  • STARTING

  • SUCCESS

  • TO_START

  • UPGRADE_FAILED

  • UPGRADING

deploy_type

String

部署类型。CCE,IEF,EXTERNAL

枚举值:

  • CCE

  • EXTERNAL

  • IEF

deployment_event_information

String

部署事件状态

enable_delete

Boolean

是否可删除

enable_upgrade

Boolean

是否可升级

image_version

String

节点镜像版本

is_high_avail

Boolean

节点是否高可用

league_id

String

空间ID

league_name

String

空间名称

league_version

String

空间版本

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取节点列表信息

get /v1/{project_id}/agents?offset=0&limit=10

响应示例

状态码: 200

查询节点列表成功

{
  "total" : 1,
  "lists" : [ {
    "highAvail" : false,
    "agent_id" : "22a38e92ef7e4284b666b2a14bc29462",
    "agent_name" : "agent_7819",
    "league_name" : "test",
    "image_version" : "1.15.1",
    "league_version" : "1.15.1",
    "league_id" : "ef73b252a0ad4b5db21a12c40a413b2f",
    "creator_user_name" : "user01",
    "creator_domain_id" : "098593b06a80d2a30f5fc004c28f6da0",
    "is_high_avail" : false,
    "deploy_type" : "CCE",
    "deploy_status" : "RUNNING",
    "create_time" : "2022-10-08T08:54:26.000+00:00",
    "enable_upgrade" : false,
    "deployment_event_information" : "Closing agent container",
    "enable_delete" : false
  } ]
}

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

    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();
        ListAgentsRequest request = new ListAgentsRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withAgentName("<agent_name>");
        request.withLeagueName("<league_name>");
        try {
            ListAgentsResponse response = client.listAgents(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
# 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 = ListAgentsRequest()
        request.limit = <limit>
        request.offset = <offset>
        request.agent_name = "<agent_name>"
        request.league_name = "<league_name>"
        response = client.list_agents(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
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.ListAgentsRequest{}
	request.Limit = int32(<limit>)
	request.Offset = int32(<offset>)
	agentNameRequest:= "<agent_name>"
	request.AgentName = &agentNameRequest
	leagueNameRequest:= "<league_name>"
	request.LeagueName = &leagueNameRequest
	response, err := client.ListAgents(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询节点列表成功

500

查询节点列表失败

分享:

    相关文档

    相关产品