下发批量安装UniAgent任务
功能介绍
该接口用于下发批量安装UniAgent任务。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/uniagent-console/mainview/batch-import
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
region |
是 |
String |
region id,例如:cn-north-7 |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
agent_import_param_list |
是 |
Array of AgentImportParamNew objects |
导入待安装UniAgent的机器参数列表。最多支持导入100台机器。 |
proxy_region_id |
是 |
Integer |
代理区域ID:
|
installer_agent_id |
是 |
String |
安装机的agent ID。 |
icagent_install_flag |
否 |
Boolean |
是否需要安装ICAgent插件:
|
plugin_install_base_param |
否 |
PluginInstallBasicParam object |
插件安装基础信息:
|
version |
是 |
String |
待安装的UniAgent版本号。 |
public_net_flag |
是 |
Boolean |
是否公网接入:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
state |
Boolean |
执行状态:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 最小长度:0 最大长度:1024 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 最小长度:0 最大长度:1024 |
请求示例
下发批量安装UniAgent任务
https://{Endpoint}/v1/{project_id}/uniagent-console/mainview/batch-import { "proxy_region_id" : 0, "public_net_flag" : false, "version" : "1.1.0", "icagent_install_flag" : false, "installer_agent_id" : "123456", "agent_import_param_list" : [ { "inner_ip" : "1.2.3.4", "os_type" : "LINUX", "port" : "22", "account" : "root", "password" : "************" } ] }
响应示例
状态码: 200
OK 请求响应成功。
{ "state" : true }
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.32000003", "error_msg" : "Invalid parameter." }
状态码: 403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.32000002", "error_msg" : "No permission." }
SDK代码示例
SDK代码示例如下。
下发批量安装UniAgent任务
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 56 57 58 59 60 61 62 63 64 65 66 |
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.aom.v4.region.AomRegion; import com.huaweicloud.sdk.aom.v4.*; import com.huaweicloud.sdk.aom.v4.model.*; import java.util.List; import java.util.ArrayList; public class BatchImportAgentSolution { 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); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); BatchImportAgentRequest request = new BatchImportAgentRequest(); AgentBatchImportParamNew body = new AgentBatchImportParamNew(); List<AgentImportParamNew> listbodyAgentImportParamList = new ArrayList<>(); listbodyAgentImportParamList.add( new AgentImportParamNew() .withPassword("************") .withInnerIp("1.2.3.4") .withPort(22) .withAccount("root") .withOsType("LINUX") ); body.withPublicNetFlag(false); body.withVersion("1.1.0"); body.withIcagentInstallFlag(false); body.withInstallerAgentId("123456"); body.withProxyRegionId(0); body.withAgentImportParamList(listbodyAgentImportParamList); request.withBody(body); try { BatchImportAgentResponse response = client.batchImportAgent(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()); } } } |
下发批量安装UniAgent任务
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v4.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v4 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 = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchImportAgentRequest() listAgentImportParamListbody = [ AgentImportParamNew( password="************", inner_ip="1.2.3.4", port=22, account="root", os_type="LINUX" ) ] request.body = AgentBatchImportParamNew( public_net_flag=False, version="1.1.0", icagent_install_flag=False, installer_agent_id="123456", proxy_region_id=0, agent_import_param_list=listAgentImportParamListbody ) response = client.batch_import_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) |
下发批量安装UniAgent任务
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v4/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 := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchImportAgentRequest{} var listAgentImportParamListbody = []model.AgentImportParamNew{ { Password: "************", InnerIp: "1.2.3.4", Port: int32(22), Account: "root", OsType: "LINUX", }, } icagentInstallFlagAgentBatchImportParamNew:= false request.Body = &model.AgentBatchImportParamNew{ PublicNetFlag: false, Version: "1.1.0", IcagentInstallFlag: &icagentInstallFlagAgentBatchImportParamNew, InstallerAgentId: "123456", ProxyRegionId: int32(0), AgentImportParamList: listAgentImportParamListbody, } response, err := client.BatchImportAgent(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。