# 获取计算节点列表 - ListAgents #### 功能介绍 功能描述：用户可以使用该接口获取可信节点信息列表。支持节点名称与空间名称的模糊查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-tics/tics_05_0021.html)。 #### URI GET /v1/{project_id}/agents 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目id，最大32位，字母和数字组成 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 是 | Integer | 每页记录数，取值0-100 | | offset | 是 | Integer | 记录数偏移量 | | 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 | 总记录数 | 表5AgentListVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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进行中 | | deploy_type | String | 部署类型:CCE.云容器集群，IEF.边缘容器,EXTERNAL.外部 | | 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代码示例如下。 - [Java] ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); TicsClient client = TicsClient.newBuilder() .withCredential(auth) .withRegion(TicsRegion.valueOf("")) .build(); ListAgentsRequest request = new ListAgentsRequest(); 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()); } } } ``` - [Python] ``` # 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = TicsClient.new_builder() \ .with_credentials(credentials) \ .with_region(TicsRegion.value_of("")) \ .build() try: request = ListAgentsRequest() 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) ``` - [Go] ``` 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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := tics.NewTicsClient( tics.TicsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.ListAgentsRequest{} response, err := client.ListAgents(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/TICS/sdk?api=ListAgents)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询节点列表成功 | | 500 | 查询节点列表失败 |