凭据客户端

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

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("<you 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)
      }
  }