全部產品
Search
文件中心

Alibaba Cloud SDK:Endpoint配置

更新時間:Aug 28, 2024

Endpoint又叫服務存取點,是請求介面服務的網路網域名稱,如產品ECS在杭州地區的Endpoint:ecs.cn-hangzhou.aliyuncs.com。每個產品都有其獨立的Endpoint,並且Endpoint與服務地區RegionId有關,不同地區可能是不同的Endpoint。本節主要介紹V2.0 SDK對於Endpoint的配置。

Endpoint類型

服務存取點主要有兩類:公網服務地址、VPC服務地址,更多資訊請參見服務存取點

Endpoint設定

V2.0 SDK提供了兩種Endpoint設定方式,下面按優先順序排列:

說明

建議您使用自訂Endpoint方式設定。

  1. 自訂Endpoint:使用者可以通過在初始化用戶端時指定Endpoint,產品的Endpoint可以通過OpenAPI 開發人員門戶的產品首頁中尋找,具體參考文末。

    import com.aliyun.ecs20140526.Client;
    import com.aliyun.teaopenapi.models.Config;
    
    public class Sample {
        public static void main(String[] args) throws Exception {
            com.aliyun.teaopenapi.models.Config config = new Config();
            config.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
            config.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            // 設定服務網域名稱 endpoint
            config.setEndpoint("<endpoint>");
            Client client = new Client(config);
        }
    }
    
  2. 自訂RegionId:

    • 若請求的產品SDK中存在RegionId和Endpoint關聯性物件,且傳入的RegionId在該對象中時,則從關聯性物件中擷取Endpoint。

    • 若請求的產品SDK沒有RegionId和Endpoint關聯性物件,或者傳入的RegionId不在關聯性物件中時,則根據拼接規則自動拼接Endpoint。

    import com.aliyun.ecs20140526.Client;
    import com.aliyun.teaopenapi.models.Config;
    
    public class Sample {
        public static void main(String[] args) throws Exception {
            Config config = new Config();
            config.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
            config.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            // 通過 regionId 映射到 endpoint
            config.setRegionId("<regionId>");
            Client client = new Client(config);
        }
    }
    

VPC Endpoint使用情境

使用阿里雲SDK方式調用OpenAPI時,若業務情境有以下需求,建議設定阿里雲VPC Endpoint:

  • 業務系統同時存在於本地機房和雲上機房,基於阿里雲VPC搭建不同的業務模組,構建完全隔離的雲上環境,雲上雲下通過公網進行業務互動。

  • 基於阿里雲VPC搭建雲上資料中心,通過專線與雲下內部資料中心打通,進行使用者核心資料安全保障,完美應對業務激增及資料快速同步,實現混合雲方案。

  • 基於阿里雲VPC搭建多個應用,各應用都需要對外提供服務,且其波峰時間點不一致,希望多IP共用頻寬,盡量減小波峰波穀效應從而降低成本。

  • 雲上業務完全基於VPC構建,使用者遍布各個地區,為提升使用者訪問速度,業務系統同樣位於不同節點,需實現各節點之間的網路高速互聯。

擷取檔案上傳授權碼的Endpoint

部分OpenAPI支援設定開放平台Endpoint,如果不設定,則使用預設的公網服務地址。它底層商務邏輯是調用檔案上傳鑒權服務,擷取鑒權和預設Object Storage Service的相關資訊。

以視覺智能開放平台的檢測人體計數介面設定VPC Endpoint為例:

import com.aliyun.facebody20191230.models.DetectBodyCountAdvanceRequest;
import com.aliyun.facebody20191230.models.DetectBodyCountResponse;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;

public class Sample {
    public static void main(String[] args) throws Exception {
        Config config = new com.aliyun.teaopenapi.models.Config();
        config.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
        config.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.setRegionId("<regionId>");
        // 設定通過 OSS 內網地址上傳檔案,如需完全內網環境請開啟注釋
        // config.setEndpointType("internal");
        com.aliyun.facebody20191230.Client client = new com.aliyun.facebody20191230.Client(config);
        // 根據 regionId 設定鑒權服務的 VPC請求地址,例如杭州 openplatform-vpc.cn-hangzhou.aliyuncs.com
        client._openPlatformEndpoint="openplatform-vpc.<regionId>.aliyuncs.com";
        RuntimeOptions runtimeOptions = new RuntimeOptions();
        // 讀取檔案並執行個體化檔案流
        File f = new File("<your-file-path>");
        InputStream in =new FileInputStream(f);

        DetectBodyCountAdvanceRequest request = new DetectBodyCountAdvanceRequest();
        request.setImageURLObject(in);
        DetectBodyCountResponse resp = client.detectBodyCountAdvance(request, runtimeOptions);
        // response 包含服務端響應的 body 和 headers
        System.out.println(new Gson().toJson(resp.body));
        System.out.println(new Gson().toJson(resp.headers));
    }
}

附:Endpoint尋找方式

產品的Endpoint可以通過在OpenAPI門戶上尋找:

  1. 在門戶頂部菜單選擇雲產品,例如ECS:

image.png

2. 在雲產品首頁找到服務地區列表

image.png

3. 選擇相應RegionId所對應的Endpoint,進行複製粘貼即可。

還可以在API調試介面,在左側欄單擊服務地區,查看雲產品支援的Endpoint。

image