密钥管理服务：凭据客户端

ECS实例RAM角色

为ECS实例授予RAM角色。具体操作，请参见通过ECS实例RAM角色授权ECS访问其他云服务。

RAM角色

1. 创建RAM角色。创建时可信实体需要选择阿里云账号或则渠道供应商，其余操作，请参见创建RAM角色。

2. 获取目标RAM角色的RamRoleArn。具体操作，请参见查看RAM角色。

   说明

   RamRoleArn是RAM角色的ARN信息，即需要扮演的角色ID。格式为acs:ram::$accountID:role/$roleName。$accountID为阿里云账号ID。$roleName为RAM角色名称。

STS

1. 创建RAM用户或RAM角色。具体操作，请参见创建RAM用户、创建RAM角色。

2. 为RAM用户或RAM角色授予AliyunSTSAssumeRoleAccess权限。具体操作，请参见为RAM用户授权、为RAM角色授权。

3. 使用RAM用户或RAM角色调用STS服务的AssumeRole接口获取STS临时访问凭证。具体操作，请参见AssumeRole - 获取扮演角色的临时身份凭证。

ClientKey

您需要先创建应用接入点AAP，然后在AAP中创建ClientKey。根据调用的API类型不同AAP的配置也不同，具体配置如下：

• 访问KMS服务Endpoint-OpenAPI

  网络规则-网络类型选择Public或VPC，权限规则-作用域选择KMS共享网关。

• 访问KMS实例Endpoint-实例API

  网络规则-网络类型选择Private，作用域选择实例ID。

具体操作，请参见创建应用接入点。

AccessKey（不推荐）

具体操作，请参见创建AccessKey。

Java

访问alibabacloud-secretsmanager-client-java了解更多安装信息和源代码。

通过Maven的方式在项目中安装凭据客户端。

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>alibabacloud-secretsmanager-client</artifactId>
    <version>1.x.x</version>
</dependency>
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.x.x</version>
</dependency>

Python

访问aliyun-secretsmanager-client-python了解更多安装信息和源代码。

执行pip命令安装凭据客户端。

pip install aliyun-secret-manager-client

Go

访问aliyun-secretsmanager-client-go了解更多安装信息和源代码。

使用go get命令，在项目中使用凭据客户端。

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

Java

• 方式一：通过系统环境变量或配置文件（secretsmanager.properties）构建客户端

  系统环境变量的详细信息，请参见附录一：系统环境变量。配置文件的详细信息，请参见附录二：配置文件。需要注意配置文件名称固定为secretsmanager.properties。

  请将示例代码中的#secretName#替换为您的凭据名称。

  import com.aliyuncs.kms.secretsmanager.client.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.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#替换为您自定义的配置文件名称，#secretName#替换为您的凭据名称。

  import com.aliyuncs.kms.secretsmanager.client.SecretCacheClient;
  import com.aliyuncs.kms.secretsmanager.client.SecretCacheClientBuilder;
  import com.aliyuncs.kms.secretsmanager.client.exception.CacheSecretException;
  import com.aliyuncs.kms.secretsmanager.client.model.SecretInfo;
  import com.aliyuncs.kms.secretsmanager.client.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）构建客户端

  说明

  阿里云账号AccessKey拥有所有OpenAPI的访问权限，建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

  本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

  • 更多认证信息配置方式，请参见管理访问凭据。

  • 不同操作系统的环境变量配置方法不同，具体操作，请参见在Linux、macOS和Windows系统配置环境变量。

  请将示例代码中的#regionId#替换为实际地域ID，#secretName#替换为您的凭据名称。

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

Python

• 方式一：通过系统环境变量或配置文件（secretsmanager.properties）构建客户端

  系统环境变量的详细信息，请参见附录一：系统环境变量。配置文件的详细信息，请参见附录二：配置文件。需要注意配置文件名称固定为secretsmanager.properties。

  请将示例代码中的#secretName#替换为您的凭据名称。

  from alibaba_cloud_secretsmanager_client.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__)

• 方式二：通过指定参数（accessKey、accessSecret、regionId）构建客户端

  说明

  阿里云账号AccessKey拥有所有OpenAPI的访问权限，建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

  本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

  • 更多认证信息配置方式，请参见管理访问凭据。

  • 不同操作系统的环境变量配置方法不同，具体操作，请参见在Linux、macOS和Windows系统配置环境变量。

  请将示例代码中的#regionId#替换为实际地域ID，#secretName#替换为您的凭据名称。

  import os
  
  from alibaba_cloud_secretsmanager_client.secret_manager_cache_client_builder import SecretManagerCacheClientBuilder
  from alibaba_cloud_secretsmanager_client.service.default_secret_manager_client_builder import DefaultSecretManagerClientBuilder
  
  if __name__ == '__main__':
      secret_cache_client = SecretManagerCacheClientBuilder.new_cache_client_builder(DefaultSecretManagerClientBuilder.standard() \
          .with_access_key(os.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")) \
          .with_region("#regionId#").build()) \
      .build();
      secret_info = secret_cache_client.get_secret_info("#secretName#")
      print(secret_info.__dict__)

Go

• 方式一：通过系统环境变量或配置文件（secretsmanager.properties）构建客户端

  系统环境变量的详细信息，请参见附录一：系统环境变量。配置文件的详细信息，请参见附录二：配置文件。需要注意配置文件名称固定为secretsmanager.properties。

  请将示例代码中的#secretName#替换为您的凭据名称。

  package main
  
  import (
      "fmt"
      "github.com/aliyun/aliyun-secretsmanager-client-go/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)
      }
      fmt.Printf("SecretValue:%s\n",secretInfo.SecretValue)
  }

• 通过指定参数（accessKey、accessSecret、regionId）构建客户端

  说明

  阿里云账号AccessKey拥有所有OpenAPI的访问权限，建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

  本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

  • 更多认证信息配置方式，请参见客户端初始化和请求方式。

  • 不同操作系统的环境变量配置方法不同，具体操作，请参见在Linux、macOS和Windows系统配置环境变量。

  请将示例代码中的#regionId#替换为实际地域ID，#secretName#替换为您的凭据名称。

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