AI 助理
备案控制台
文档
输入文档关键字查找
首页 在线迁移服务 开发参考 SDK参考 Java SDK 代理

代理

更新时间：
我的收藏

本文介绍如何使用SDK调用代理相关的方法。

创建代理

说明

使用代理前务必先部署代理，SDK无法自动部署代理，请参考文档部署代理 按照文档提示操作。仅当使用专线或者VPN的情况下才需要创建代理，公网场景一般无须创建代理。

以下示例代码用于创建代理。

package sample;

import com.aliyun.hcs_mgw20240626.Client;
import com.aliyun.hcs_mgw20240626.models.CreateAgentInfo;
import com.aliyun.hcs_mgw20240626.models.CreateAgentRequest;

public class Demo {
	/** 
	  强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
	*/
	static String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
	static String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
	/** 填写主账号ID。*/
	static String userId = "11470***876***55";

	public static void main(String[] args) {
		// 填写通道ID。
		String tunnelId = "ab31d1f9-****-4f62-****-914e4b2f78c7";
		// 填写代理名称。
		String agentName = "exampleagent";
		// 使用网络，公网请填写public, 专线或者VPN请填写vpc
		String agentEndpoint = "public";
		// 部署方式，目前仅支持填写default。
		String deployMethod = "default";
		try {
			com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
			// 这里以北京区域为例。
			config.setEndpoint("cn-beijing.mgw.aliyuncs.com");
			config.setRegionId(accessKeyId);
			config.setAccessKeyId(accessKeyId);
			config.setAccessKeySecret(accessKeySecret);
			Client client = new Client(config);
			CreateAgentRequest request = new CreateAgentRequest();
			CreateAgentInfo info = new CreateAgentInfo();
			info.setName(agentName);
			info.setTunnelId(tunnelId);
			info.setAgentEndpoint(agentEndpoint);
			info.setDeployMethod(deployMethod);
			request.setImportAgent(info);
			client.createAgent(userId, request);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

获取代理状态

以下示例代码用于获取指定代理状态。

package sample;

import com.aliyun.hcs_mgw20240626.Client;
import com.aliyun.hcs_mgw20240626.models.GetAgentStatusResponse;
import com.google.gson.Gson;

public class Demo {
   /** 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。*/
   static String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
   static String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
   /** 填写主账号ID。*/
   static String userId = "11470***876***55";

   public static void main(String[] args) {
      // 填写代理名称。
      String agentName = "exampleagent";
      try {
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
         // 这里以北京区域为例。
         config.setEndpoint("cn-beijing.mgw.aliyuncs.com");
         config.setRegionId(accessKeyId);
         config.setAccessKeyId(accessKeyId);
         config.setAccessKeySecret(accessKeySecret);
         Client client = new Client(config);
         GetAgentStatusResponse resp = client.getAgentStatus(userId, agentName);
         // 如果status字段显示的是OK,说明代理状态正常，其它任何值都表示代理异常。
         System.out.println(new Gson().toJson(resp.getBody().getImportAgentStatus()));
      } catch (Exception e) {
         e.printStackTrace();
      }
   }
}

正常返回示例

{
  "ImportAgentStatus": {
    "Status": "OK"
  }
}

获取代理详情

以下示例代码用于查询指定代理详情信息。

package sample;

import com.aliyun.hcs_mgw20240626.Client;
import com.aliyun.hcs_mgw20240626.models.GetAgentResponse;
import com.google.gson.Gson;

public class Demo {
   /** 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。*/
   static String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
   static String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
   /** 填写主账号ID。*/
   static String userId = "11470***876***55";

   public static void main(String[] args) {
      // 填写代理名称。
      String agentName = "exampleagent";
      try {
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
         // 这里以北京区域为例。
         config.setEndpoint("cn-beijing.mgw.aliyuncs.com");
         config.setRegionId(accessKeyId);
         config.setAccessKeyId(accessKeyId);
         config.setAccessKeySecret(accessKeySecret);
         Client client = new Client(config);
         GetAgentResponse resp = client.getAgent(userId, agentName);
         System.out.println(new Gson().toJson(resp.getBody().getImportAgent()));
      } catch (Exception e) {
         e.printStackTrace();
      }
   }
}

正常返回示例

{
  "ImportAgent": {
    "Owner": "test_owner",
    "Name": "test_name",
    "CreateTime": "2024-05-01T12:00:00.000Z",
    "ModifyTime": "2024-05-01T12:00:00.000Z",
    "DeployMethod": "default",
    "AgentEndpoint": "vpc",
    "ActivationKey": "6af62558-970d-4f44-8663-4e297170fd6a",
    "Tags": "K1:V1,K2:V2",
    "Version": "test_agent_id",
    "TunnelId": "test_tunnel_id"
  }
}

列举代理

以下示例代码用于列举主账号下所有代理信息。

package sample;

import com.aliyun.hcs_mgw20240626.Client;
import com.aliyun.hcs_mgw20240626.models.ListAgentRequest;
import com.aliyun.hcs_mgw20240626.models.ListAgentResponse;
import com.google.gson.Gson;

public class Demo {
   /** 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。*/
   static String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
   static String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
   /** 填写主账号ID。*/
   static String userId = "11470***876***55";

   public static void main(String[] args) {
      try {
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
         // 这里以北京区域为例。
         config.setEndpoint("cn-beijing.mgw.aliyuncs.com");
         config.setRegionId(accessKeyId);
         config.setAccessKeyId(accessKeyId);
         config.setAccessKeySecret(accessKeySecret);
         Client client = new Client(config);
         ListAgentRequest request = new ListAgentRequest();
         // 根据实际填写marker,count。
	 String marker = "";
	 int count = 1;
	 request.setMarker(marker);
         request.setCount(count);
         ListAgentResponse resp = client.listAgent(userId, request);
         System.out.println(new Gson().toJson(resp.getBody().getImportAgentList()));
      } catch (Exception e) {
         e.printStackTrace();
      }
   }
}

正常返回示例

{
  "ImportAgentList": {
    "Truncated": true,
    "NextMarker": "test_next_marker",
    "ImportAgent": [
      {
        "Owner": "test_owner",
        "Name": "test_name",
        "CreateTime": "2024-05-01T12:00:00.000Z",
        "ModifyTime": "2024-05-01T12:00:00.000Z",
        "DeployMethod": "default",
        "AgentEndpoint": "vpc",
        "ActivationKey": "6af62558-970d-4f44-8663-4e297170fd6a",
        "Tags": "K1:V1,K2:V2",
        "Version": "test_agent_id",
        "TunnelId": "test_tunnel_id"
      }
    ]
  }
}

删除代理

以下示例代码用于删除指定代理。

package sample;

import com.aliyun.hcs_mgw20240626.Client;
import com.aliyun.hcs_mgw20240626.models.DeleteAgentResponse;

public class Demo {
   /** 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。*/
   static String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
   static String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
   /** 填写主账号ID。*/
   static String userId = "11470***876***55";

   public static void main(String[] args) {
      // 填写代理名称。
      String agentName = "exampleagent";
      try {
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
         // 这里以北京区域为例。
         config.setEndpoint("cn-beijing.mgw.aliyuncs.com");
         config.setRegionId(accessKeyId);
         config.setAccessKeyId(accessKeyId);
         config.setAccessKeySecret(accessKeySecret);
         Client client = new Client(config);
         DeleteAgentResponse resp = client.deleteAgent(userId, agentName);
         System.out.println(resp.statusCode);
      } catch (Exception e) {
         e.printStackTrace();
      }
   }
}

后续步骤

代理创建后，您可以选择继续执行创建数据地址操作，详情请参见数据地址 。

上一篇：通道下一篇：数据地址
文档推荐