Key Management Service：憑據用戶端

Java

通過 Maven 的方式在專案中安裝憑據用戶端。

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>alibabacloud-secretsmanager-client-v2</artifactId>
    <version>x.x.x</version>
</dependency>

Python

執行pip命令安裝憑據用戶端。

# 如果下述命令報錯，請將pip替換為pip3
pip install alibabacloud_secretsmanager_client_v2

Go

使用 go get 命令安裝憑據用戶端。

go get -u github.com/aliyun/alibabacloud-secretsmanager-client-go-v2

Node.js

通過 npm 或 yarn 在專案中使用憑據用戶端。

• npm

  npm install alibabacloud-secretsmanager-client-v2

• yarn

  yarn add alibabacloud-secretsmanager-client-v2

ECS 執行個體 RAM 角色

AccessKey

OIDC Role ARN

AK+RamRoleArn

ClientKey（不推薦）

Java

• 使用預設配置：此方式SDK會自動讀取secretsmanager.properties檔案或環境變數中的憑證資訊。

  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.v2.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.v2.model.SecretInfo;
  
  public class CacheClientEnvironmentSample {
  
      public static void main(String[] args) {
          try {
              SecretCacheClient client = SecretCacheClientBuilder.newClient();
              SecretInfo secretInfo = client.getSecretInfo("#secretName#");
              System.out.println(secretInfo);
          } catch (CacheSecretException e) {
              e.printStackTrace();
          }
      }
  }

• 使用自訂設定檔：此方式適用於設定檔未使用預設檔案名稱或自訂檔案路徑的情境，需指定設定檔的路徑（#customConfigFileName#）。

  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.v2.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.v2.model.SecretInfo;
  import com.aliyuncs.kms.secretsmanager.client.v2.service.BaseSecretManagerClientBuilder;
  
  public class CacheClientCustomConfigFileSample {
  
      public static void main(String[] args) {
          try {
              SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                      BaseSecretManagerClientBuilder.standard().withCustomConfigFile("#customConfigFileName#").build()).build();
              SecretInfo secretInfo = client.getSecretInfo("#secretName#");
              System.out.println(secretInfo);
          } catch (CacheSecretException e) {
              System.out.println("CacheSecretException:" + e.getMessage());
          }
      }
  }

• 寫入程式碼方式（指定 AccessKey、AccessSecret、RegionId 等）：無需將 AK 寫入設定檔或預設環境變數，初始化用戶端時傳入對應的 AK 和訪問地區資訊即可。

  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.v2.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.v2.model.RegionInfo;
  import com.aliyuncs.kms.secretsmanager.client.v2.service.BaseSecretManagerClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.v2.utils.CredentialsProviderUtils;
  
  public class CacheClientWithCaCertificateSample {
      public static void main(String[] args) {
          try {
              // 建立包含憑證路徑的 RegionInfo
              RegionInfo regionInfo = new RegionInfo();
              regionInfo.setRegionId("#regionId#");
              regionInfo.setEndpoint("<your kms instanceId>.cryptoservice.kms.aliyuncs.com"); //專屬網關訪問地址，若訪問共用網關，可不設定。 
              SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                      BaseSecretManagerClientBuilder.standard()
                              .withCredentialsProvider(CredentialsProviderUtils.withAccessKey(
                                      System.getenv("#accessKeyId#"), 
                                      System.getenv("#accessKeySecret#")))
                              .addRegion(regionInfo) 
                              .build())
                      .build();
              SecretInfo secretInfo = client.getSecretInfo("#secretName#");
          } catch (CacheSecretException e) {
              e.printStackTrace();
          }
      }
  }

• 使用阿里雲預設憑據鏈：預設憑據鏈是一種兜底策略，按照內建的憑據尋找順序逐層向下尋找，直至擷取憑據資訊。若所有情況均未成功則表示鑒權失敗，無法擷取憑據。

  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.v2.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.v2.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.v2.model.SecretInfo;
  import com.aliyuncs.kms.secretsmanager.client.v2.service.BaseSecretManagerClientBuilder;
  
  public class CacheClientDefaultCredentialChainSample {
  
      public static void main(String[] args) {
          try {
              SecretCacheClient client = SecretCacheClientBuilder.newCacheClientBuilder(
                      BaseSecretManagerClientBuilder.standard().withRegion("#regionId#").build()).build();
              SecretInfo secretInfo = client.getSecretInfo("#secretName#");
              System.out.println(secretInfo);
          } catch (CacheSecretException e) {
              e.printStackTrace();
          }
      }
  }

Python

• 使用預設配置：此方式SDK會自動讀取secretsmanager.properties檔案或環境變數中的憑證資訊。

  from alibabacloud_secretsmanager_client_v2.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
  
  if __name__ == '__main__':
      secret_cache_client = SecretManagerCacheClientBuilder.new_client()
      secret_info = secret_cache_client.get_secret_info("#secretName#")
      print(secret_info.__dict__)

• 使用自訂設定檔：此方式適用於設定檔未使用預設檔案名稱或自訂檔案路徑的情境，需指定設定檔的路徑（#customConfigFileName#）。

  from alibabacloud_secretsmanager_client_v2.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
  from alibabacloud_secretsmanager_client_v2.service.default_secret_manager_client_builder import DefaultSecretManagerClientBuilder
  
  if __name__ == '__main__':
      secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
          DefaultSecretManagerClientBuilder.standard().with_custom_config_file("#customConfigFileName#").build()).build()
      secret_info = secret_cache_client.get_secret_info("#secretName#")
      print(secret_info.__dict__)

• 寫入程式碼方式（指定 AccessKey、AccessSecret、RegionId 等）：無需將 AK 寫入設定檔或預設環境變數，初始化用戶端時傳入對應的 AK 和訪問地區資訊即可。

  import os
  
  from alibabacloud_secretsmanager_client_v2.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
  from alibabacloud_secretsmanager_client_v2.service.default_secret_manager_client_builder import \
      DefaultSecretManagerClientBuilder
  from alibabacloud_secretsmanager_client_v2.model.region_info import RegionInfo
  
  if __name__ == '__main__':
      # 建立包含 CA 憑證路徑的 RegionInfo
      region_info = RegionInfo(
          region_id="#regionId#",
          endpoint="#kmsInstanceEndpoint#",  # 專屬網關訪問地址，若訪問共用網關，可不設定。 
      )
      secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
          DefaultSecretManagerClientBuilder.standard()
          .with_access_key(
              os.getenv("#accessKeyId#"),
              os.getenv("#accessKeySecret#"))
          .add_region_info(region_info)  
          .build()).build()
      # ... 使用 client

• 使用阿里雲預設憑據鏈：預設憑據鏈是一種兜底策略，按照內建的憑據尋找順序逐層向下尋找，直至擷取憑據資訊。若所有情況均未成功則表示鑒權失敗，無法擷取憑據。

  from alibabacloud_secretsmanager_client_v2.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
  from alibabacloud_secretsmanager_client_v2.service.default_secret_manager_client_builder import DefaultSecretManagerClientBuilder
  
  if __name__ == '__main__':
      secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(
          DefaultSecretManagerClientBuilder.standard().with_region("#regionId#").build()).build()
      secret_info = secret_cache_client.get_secret_info("#secretName#")
      print(secret_info.__dict__)

Go

• 使用預設配置：此方式SDK會自動讀取secretsmanager.properties檔案或環境變數中的憑證資訊。

  package main
  
  import "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk"
  
  func main() {
      client, err := sdk.NewClient()
      if err != nil {
          // Handle exceptions
          panic(err)
      }
      secretInfo, err := client.GetSecretInfo("#secretName#")
      if err != nil {
          // Handle exceptions
          panic(err)
      }
  }

• 使用自訂設定檔：此方式適用於設定檔未使用預設檔案名稱或自訂檔案路徑的情境，需指定設定檔的路徑（#customConfigFileName#）。

  package main
  
  import (
      "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk"
      "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk/service"
  )
  
  func main() {
      client, err := sdk.NewSecretCacheClientBuilder(
              service.NewDefaultSecretManagerClientBuilder().Standard().WithCustomConfigFile("#customConfigFileName#").Build()).Build()
      if err != nil {
          // Handle exceptions
          panic(err)
      }
      secretInfo, err := client.GetSecretInfo("#secretName#")
      if err != nil {
          // Handle exceptions
          panic(err)
      }
  }

• 寫入程式碼方式（指定 AccessKey、AccessSecret、RegionId 等）：無需將 AK 寫入設定檔或預設環境變數，初始化用戶端時傳入對應的 AK 和訪問地區資訊即可。

  package main
  import (
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk/models"
    "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk/service"
    "os"
  )
  
  func main() {
    regionInfo := &models.RegionInfo{
      RegionId:   "#regionId#",
      Endpoint:   "<kmsInstanceId>.cryptoservice.kms.aliyuncs.com", //專屬網關訪問地址，若訪問共用網關，可不設定。
    }
  
    client, err := sdk.NewSecretCacheClientBuilder(
      service.NewDefaultSecretManagerClientBuilder().
        Standard().
        WithAccessKey(os.Getenv("#accessKeyId#"), os.Getenv("#accessKeySecret#")).
        AddRegionInfo(regionInfo).
        Build()).Build()
    if err != nil {
      // Handle exceptions
      panic(err)
    }
    secretInfo, err := client.GetSecretInfo("#secretName#")
    if err != nil {
      // Handle exceptions
      panic(err)
    }
  }

• 使用阿里雲預設憑據鏈：預設憑據鏈是一種兜底策略，按照內建的憑據尋找順序逐層向下尋找，直至擷取憑據資訊。若所有情況均未成功則表示鑒權失敗，無法擷取憑據。

  package main
  
  import (
      "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk"
      "github.com/aliyun/alibabacloud-secretsmanager-client-go-v2/sdk/service"
  )
  
  func main() {
      client, err := sdk.NewSecretCacheClientBuilder(
              service.NewDefaultSecretManagerClientBuilder().Standard().WithRegion("#regionId#").Build()).Build()
      if err != nil {
          // Handle exceptions
          panic(err)
      }
      secretInfo, err := client.GetSecretInfo("#secretName#")
      if err != nil {
          // Handle exceptions
          panic(err)
      }
  }

Node.js

• 使用預設配置：此方式SDK會自動讀取secretsmanager.properties檔案或環境變數中的憑證資訊。

  import { SecretCacheClientBuilder } from 'alibabacloud-secretsmanager-client-v2';
  
  async function example() {
    try {
      // 通過環境變數或預設配置構建用戶端
      const client = await SecretCacheClientBuilder.newClient();
      const secretInfo = await client.getSecretInfo('#secretName#');
      console.log(secretInfo);
    } catch (error) {
      console.error('Error:', error);
    }
  }
  
  example();

• 使用自訂設定檔：此方式適用於設定檔未使用預設檔案名稱或自訂檔案路徑的情境，需指定設定檔的路徑（#customConfigFileName#）。

  import {
    SecretCacheClientBuilder,
    BaseSecretManagerClientBuilder,
    CredentialsProviderUtils
  } from 'alibabacloud-secretsmanager-client-v2';
  
  async function example() {
    try {
      const client = await SecretCacheClientBuilder.newCacheClientBuilder(
        BaseSecretManagerClientBuilder.standard().withCustomConfigFile('#customConfigFileName#').build()
      ).build();
  
      const secretInfo = await client.getSecretInfo('#secretName#');
      console.log(secretInfo);
    } catch (error) {
      console.error('Error:', error);
    }
  }
  
  example();

• 寫入程式碼方式（指定 AccessKey、AccessSecret、RegionId 等）：無需將 AK 寫入設定檔或預設環境變數，初始化用戶端時傳入對應的 AK 和訪問地區資訊即可。

  import {
    SecretCacheClientBuilder,
    BaseSecretManagerClientBuilder,
    CredentialsProviderUtils,
    RegionInfo
  } from 'alibabacloud-secretsmanager-client-v2';
  
  async function example() {
    try {
      const regionInfo = new RegionInfo();
      regionInfo.setRegionId('#regionId#');
      regionInfo.setEndpoint('<kmsInstanceId>.cryptoservice.kms.aliyuncs.com'); // 專屬網關訪問地址，若訪問共用網關，可不設定。
  
      const client = await SecretCacheClientBuilder.newCacheClientBuilder(
        BaseSecretManagerClientBuilder.standard()
          .withCredentialsProvider(
            CredentialsProviderUtils.withAccessKey(
              process.env['#accessKeyId#'],
              process.env['#accessKeySecret#']
            )
          )
          .addRegionInfo(regionInfo) // 使用帶 CA 憑證路徑的 RegionInfo
          .build()
      ).build();
  
      const secretInfo = await client.getSecretInfo('#secretName#');
      console.log(secretInfo);
    } catch (error) {
      console.error('Error:', error);
    }
  }
  
  example();

• 使用阿里雲預設憑據鏈：預設憑據鏈是一種兜底策略，按照內建的憑據尋找順序逐層向下尋找，直至擷取憑據資訊。若所有情況均未成功則表示鑒權失敗，無法擷取憑據。

  import {
    SecretCacheClientBuilder,
    BaseSecretManagerClientBuilder,
    CredentialsProviderUtils
  } from 'alibabacloud-secretsmanager-client-v2';
  
  async function example() {
    try {
      const client = await SecretCacheClientBuilder.newCacheClientBuilder(
        BaseSecretManagerClientBuilder.standard()
          .withCredentialsProvider(CredentialsProviderUtils.withDefaultCredential())
          .withRegion('#regionId#')
          .build()
      ).build();
  
      const secretInfo = await client.getSecretInfo('#secretName#');
      console.log(secretInfo);
    } catch (error) {
      console.error('Error:', error);
    }
  }
  
  example();