V2.0 JavaSDK如何配置Endpoint - 阿里云SDK

在使用SDK调用OpenAPI时，必须正确配置目标云产品的Endpoint。例如，在创建资源时，应优先选择与业务物理位置最近的地域Endpoint，以降低网络延迟并提高响应速度。在进行查询、更新或删除资源时，必须选择资源所在地域的Endpoint，因为资源存储具有地域属性，跨地域操作可能导致访问失败或数据一致性风险。本节主要介绍V2.0 SDK对于Endpoint的配置。

Endpoint类型

Endpoint主要分为两类：公网Endpoint和VPC Endpoint。当您的业务部署在VPC网络（例如ECS、ACK等）时，为了提高安全性并降低网络延迟，您可以选择通过VPC Endpoint访问该VPC内的云上资源。更多信息请参见服务接入点。

Endpoint设置

V2.0 SDK提供了两种Endpoint设置方式，分别为指定Endpoint和通过指定RegionId自动获取Endpoint。

方式一：指定Endpoint（推荐）

可以在初始化云产品客户端对象时指定Endpoint，支持公网Endpoint和VPC Endpoint。

示例代码：

com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
// 设置endpoint
config.setEndpoint("<ENDPOINT>");

方式二：指定RegionId

在未指定Endpoint的情况下，可以在初始化云产品客户端对象时指定RegionId，SDK底层将通过自动寻址的方式获取相应的Endpoint。

寻址逻辑如下：

在大多数云产品SDK中，定义了RegionId与Endpoint之间的映射关系endpointMap。例如，ECS SDK中的endpointMap内容如下：

{
    "ap-northeast-2-pop": "ecs.aliyuncs.com",
    "cn-beijing-finance-pop": "ecs.aliyuncs.com",
    "cn-beijing-gov-1": "ecs.aliyuncs.com",
    "cn-beijing-nu16-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-edge-1": "ecs.cn-qingdao-nebula.aliyuncs.com",
    "cn-fujian": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-haidian-cm12-c01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-bj-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-finance": "ecs.aliyuncs.com",
    "cn-hangzhou-internal-prod-1": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-internal-test-1": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-internal-test-2": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-internal-test-3": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hangzhou-test-306": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-hongkong-finance-pop": "ecs.aliyuncs.com",
    "cn-huhehaote-nebula-1": "ecs.cn-qingdao-nebula.aliyuncs.com",
    "cn-north-2-gov-1": "ecs.aliyuncs.com",
    "cn-shanghai-et15-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shanghai-et2-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shanghai-finance-1": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shanghai-inner": "ecs.aliyuncs.com",
    "cn-shanghai-internal-test-1": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shenzhen-finance-1": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shenzhen-inner": "ecs.aliyuncs.com",
    "cn-shenzhen-st4-d01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-shenzhen-su18-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-wuhan": "ecs.aliyuncs.com",
    "cn-yushanfang": "ecs.aliyuncs.com",
    "cn-zhangbei": "ecs.aliyuncs.com",
    "cn-zhangbei-na61-b01": "ecs-cn-hangzhou.aliyuncs.com",
    "cn-zhangjiakou-na62-a01": "ecs.cn-zhangjiakou.aliyuncs.com",
    "cn-zhengzhou-nebula-1": "ecs.cn-qingdao-nebula.aliyuncs.com",
    "eu-west-1-oxs": "ecs.cn-shenzhen-cloudstone.aliyuncs.com",
    "rus-west-1-pop": "ecs.aliyuncs.com"
}

首先判断是否存在endpointMap，若不存在，则根据拼接规则自动拼接Endpoint。
若endpointMap存在且包含指定的RegionId时，则Endpoint为指定的RegionId对应的值。
若endpointMap中不包含指定的RegionId时，则根据拼接规则自动拼接Endpoint。

拼接规则如下：

区域化部署产品：<PRODUCT_CODE><SUFFIX><NET_WORK>.<REGION_ID>.aliyuncs.com
中心化部署产品：<PRODUCT_CODE><SUFFIX><NET_WORK>.aliyuncs.com

其中，部署类型和<PRODUCT_CODE>由所使用的云产品SDK决定，其他三个参数需根据实际情况填写：

<SUFFIX>：VPC Endpoint中后缀。如何填写请参照云产品VPC Endpoint中的后缀，请注意无需添加中横线（-）。
<NET_WORK>：Endpoint类型，默认使用公网Endpoint，可通过以下可选值修改Endpoint类型：
- vpc：可通过该值获取VPC服务接入点。
- intranet：使用日志服务SDK（sls20201230）时，可通过该值获取日志服务的VPC接入点。
- accelerate：使用日志服务SDK（sls20201230）时，可通过该值获取日志服务的传输加速服务入口。
<REGION_ID>：资源所在地域。

说明

由于VPC Endpoint格式多样，因此不建议使用该方式拼接VPC Endpoint，建议使用指定Endpoint的方式配置VPC Endpoint。

示例代码：

com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
// 指定regionId
config.setRegionId("<REGION_ID>");
config.setNetwork("<NET_WORK>"); // 公网Endpoint无需设置该参数，VPC Endpoint：vpc。
config.setSuffix("SUFFIX"); // 公网Endpoint无需设置该参数，VPC Endpoint请参照云产品VPC Endpoint中的后缀，请注意无需添加中横线（-）。

附：Endpoint查找方式

产品的Endpoint可以通过在OpenAPI门户上寻找：

在门户顶部菜单选择云产品，例如ECS。
在云产品主页找到服务区域列表。
选择相应RegionId所对应的Endpoint，进行复制粘贴即可。

还可以在API调试界面，在左侧栏单击服务区域，查看云产品支持的Endpoint。