注册客户端
功能介绍
注册客户端,安装时候由Agent调用,无需手动注册。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/agents
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
agent |
是 |
AgentRegister object |
客户端注册参数 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
agent |
Agent object |
客户端详情 |
参数 |
参数类型 |
描述 |
---|---|---|
created_at |
String |
客户端创建时间 |
updated_at |
String |
客户端更新时间 |
agent_id |
String |
客户端ID |
agent_version |
String |
客户端版本号 |
agent_type |
String |
客户端类型 |
host_name |
String |
客户端所在的主机名 |
host_nickname |
String |
客户端所在的主机昵称 |
host_ip |
String |
客户端所在主机的IP |
host_os |
String |
客户端主机所在的操作系统 |
status |
String |
客户端状态 |
last_active_time |
String |
客户端上次激活时间 |
paths |
Array of Path objects |
客户端的备份路径 |
请求示例
注册客户端由agent安装时自动触发,无需客户手动调用。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents { "agent" : { "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "host_name" : "ecs-00002", "host_ip" : "10.10.0.2", "host_os" : "linux", "agent_version" : "1.0.0", "agent_type" : "native" } }
响应示例
状态码: 200
OK
{ "agent" : { "created_at" : "2022-01-30T09:28:09.334+00:00", "updated_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "agent_version" : "1.0.0", "agent_type" : "native", "host_name" : "ecs-0001", "host_nickname" : "", "host_ip" : "192.168.10.144", "host_os" : "linux", "status" : "normal", "last_active_time" : "2022-01-30T09:28:08.960+00:00" } }
SDK代码示例
SDK代码示例如下。
Java
注册客户端由agent安装时自动触发,无需客户手动调用。
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 54 55 |
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 RegisterAgentSolution { 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(); RegisterAgentRequest request = new RegisterAgentRequest(); AgentRegisterReq body = new AgentRegisterReq(); AgentRegister agentbody = new AgentRegister(); agentbody.withAgentId("489654f2-363b-4ebf-966a-bdf079d97114") .withHostName("ecs-00002") .withHostIp("10.10.0.2") .withHostOs("linux") .withAgentVersion("1.0.0") .withAgentType("native"); body.withAgent(agentbody); request.withBody(body); try { RegisterAgentResponse response = client.registerAgent(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
注册客户端由agent安装时自动触发,无需客户手动调用。
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 |
# 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 = RegisterAgentRequest() agentbody = AgentRegister( agent_id="489654f2-363b-4ebf-966a-bdf079d97114", host_name="ecs-00002", host_ip="10.10.0.2", host_os="linux", agent_version="1.0.0", agent_type="native" ) request.body = AgentRegisterReq( agent=agentbody ) response = client.register_agent(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
注册客户端由agent安装时自动触发,无需客户手动调用。
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 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.RegisterAgentRequest{} agentVersionAgent:= "1.0.0" agentTypeAgent:= "native" agentbody := &model.AgentRegister{ AgentId: "489654f2-363b-4ebf-966a-bdf079d97114", HostName: "ecs-00002", HostIp: "10.10.0.2", HostOs: "linux", AgentVersion: &agentVersionAgent, AgentType: &agentTypeAgent, } request.Body = &model.AgentRegisterReq{ Agent: agentbody, } response, err := client.RegisterAgent(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。