密钥管理服务：RAM凭据插件

Java

阿里云Java SDK（V1.0）

1. 通过Maven的方式在项目中引入RAM凭据插件。

   <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>aliyun-java-sdk-core</artifactId>
      <version>[4.3.2,5.0.0)</version>
   </dependency>
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>aliyun-java-sdk-core-managed-credentials-provider</artifactId>
     <version>[1.3.1,)</version>
   </dependency>

   说明

   建议您安装最新版本的插件，更多信息，请参见原始代码。

2. 获得阿里云Java SDK客户端并调用云服务。

   以调用ECS DescribeInstanceStatus为例：

   运行以下示例代码时，请自行在pom.xml中添加云服务器aliyun-java-sdk-ecs依赖。

   import com.aliyuncs.IAcsClient;
   import com.aliyuncs.ecs.model.v20140526.DescribeInstanceStatusRequest;
   import com.aliyuncs.ecs.model.v20140526.DescribeInstanceStatusResponse;
   import com.aliyun.kms.secretsmanager.plugin.sdkcore.ProxyAcsClient;
   import com.aliyuncs.exceptions.ClientException;
   import com.aliyuncs.exceptions.ServerException;
   
   public class AliyunSdkProviderSample {
       public static void main(String[]args) {
           String secretName="******";
           /*
             如果应用无法设置从classpath和可执行jar包中读取默认配置文件（managed_credentials_providers.properties），
             或需自定义配置文件名称时，可调用以下代码设置自定义配置文件,并按以下顺序读取：
             1."your-config-name"配置绝对路径+文件名称，即读取绝对路径下的文件
             2."your-config-name"仅配置文件名称，默认先读取classpath下的配置文件，再读取可执行jar包中的配置文件
           */
           //ConfigLoader.setConfigName("your-config-name");
           
           // 1. 获取ACSClient by aliyun-java-sdk-managed-credentials-provider
           IAcsClient client = null;
           try {
               client = new ProxyAcsClient("<the regionId of ECS>", secretName);
           } catch (ClientException e) {
                e.printStackTrace();
            }
           // 2. 调用ECS的OpenAPI实现业务功能
           DescribeInstanceStatusRequest request = new DescribeInstanceStatusRequest();
           DescribeInstanceStatusResponse response;
           try {
                response = client.getAcsResponse(request);
           } catch (ServerException e) {
                e.printStackTrace();
            } catch (ClientException e) {
                e.printStackTrace();
            }
           // 3. 通过下面方法关闭客户端来释放插件关联的资源 
           client.shutdown();
       }
   }

在OSS SDK中使用

1. 通过Maven的方式在项目中引入RAM凭据插件。

   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-core</artifactId>
       <version>4.5.17</version>
   </dependency>
   <dependency>
   <groupId>com.aliyun.oss</groupId>
   <artifactId>aliyun-sdk-oss</artifactId>
   <version>[2.1.0,3.10.2]</version>
   <exclusions>
       <exclusion>
           <groupId>com.aliyun</groupId>
           <artifactId>aliyun-java-sdk-kms</artifactId>
       </exclusion>
   </exclusions>
   </dependency>
   <dependency>
   <groupId>com.aliyun</groupId>
   <artifactId>aliyun-sdk-oss-managed-credentials-provider</artifactId>
   <version>[1.3.1,]</version>
   </dependency>

   说明

   建议您安装最新版本的插件，更多信息，请参见原始代码。

2. 获得OSS Java SDK客户端并调用云服务。

   以调用OSS listBuckets 为例：

   import com.aliyun.kms.secretsmanager.plugin.oss.ProxyOSSClientBuilder;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.model.Bucket;
   
   import java.util.List;
   
   public class OssProviderSample {
   
       public static void main(String[] args) throws Exception {
           String secretName = "******";
           String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
   
           /*
             如果应用无法设置从classpath和可执行jar包中读取默认配置文件（managed_credentials_providers.properties），
             或需自定义配置文件名称时，可调用以下代码设置自定义配置文件,并按以下顺序读取：
             1."your-config-name"配置绝对路径+文件名称，即读取绝对路径下的文件
             2."your-config-name"仅配置文件名称，默认先读取classpath下的配置文件，再读取可执行jar包中的配置文件
           */
           //ConfigLoader.setConfigName("your-config-name");
   
           // 获取Oss Client
           OSS ossClient = new ProxyOSSClientBuilder().build(endpoint, secretName);
   
   
           // 以下为业务方业务代码：调用阿里云OSS服务实现业务功能
           List<Bucket> buckets = ossClient.listBuckets();
           for (Bucket bucket : buckets) {
               if (bucket != null) {
                   // ...
               }
           }
   
           // 通过下面方法关闭客户端来释放插件关联的资源 
           ossClient.shutdown();
       }
   
   }

Python

阿里云Python SDK（V1.0）

1. 执行pip命令以在项目中使用RAM凭据插件。

   pip install aliyun-openapi-python-sdk-managed-credentials-provider

   说明

   请确保插件版本为0.1.0及以上版本，更多信息，请参见原始代码。

2. 获得阿里云Python SDK客户端并调用云服务。

   from aliyun_sdk_secretsmanager_sdk_core_plugin.proxy_acs_client import ProxyAcsClient
   
      region="cn-hangzhou"
      secretName="******"
   
      # 1. 获取ACSClient
      client = ProxyAcsClient(region_id=region, secret_name=secretName )
   
      # 2. 业务方业务代码：使用client调用阿里云服务，无需代码改动。
      ...
   
      # 3. 通过下面方法关闭客户端来释放插件关联的资源
      client.shutdown()

OSS Python SDK

1. 执行pip命令以在项目中使用RAM凭据插件。

   pip install aliyun-oss-python-sdk-managed-credentials-provider

   说明

   请确保插件版本为0.1.0及以上版本，更多信息，请参见原始代码。

2. 获得阿里云OSS Python SDK客户端并调用云服务。

   from aliyun_sdk_secretsmanager_oss_plugin.proxy_bucket import ProxyBucket
   from itertools import islice
   
   endpoint = "******"
   secret_name ="******"
   bucket_name = "******"
   bucket = ProxyBucket(secret_name=secret_name, endpoint=endpoint, bucket_name=bucket_name)
   objects = bucket.list_objects()
   for b in islice(objects.object_list, 10):
       print(b.key)
   bucket.shutdown()

Go

阿里云Go SDK（V1.0）

1. 安装阿里云Go SDK的RAM凭据插件。

   说明

   建议您安装最新版本的插件，更多信息，请参见原始代码。

   • 方式一：使用go.mod管理您的依赖。

     在go.mod文件中添加以下内容安装依赖包。

     require (
         github.com/aliyun/aliyun-sdk-managed-credentials-providers-go/aliyun-sdk-managed-credentials-providers/alibaba-cloud-sdk-go-managed-credentials-provider vX.X.X
     )

   • 方式二：使用go get命令获取远程代码包。

     go get -u github.com/aliyun/aliyun-sdk-mxanaged-credentials-providers-go/aliyun-sdk-managed-credentials-providers/alibaba-cloud-sdk-go-managed-credentials-provider

2. 获得阿里云Go SDK的客户端并调用云服务。

   以调用ECS DescribeInstances 为例：

   package sample
   
   import (
       "fmt"
       "github.com/aliyun/alibaba-cloud-sdk-go/services/ecs"
       sdkcoreprovider "github.com/aliyun/aliyun-sdk-managed-credentials-providers-go/aliyun-sdk-managed-credentials-providers/alibaba-cloud-sdk-go-managed-credentials-provider/sdk"
   )
   
   func main() {
       secretName := "********"
       regionId := "cn-hangzhou"
   
       client, err := sdkcoreprovider.GetClient(&ecs.Client{}, regionId, secretName)
       if err != nil {
           fmt.Println(err)
           return
       }
       ecsClient := client.(*ecs.Client)
   
       request := ecs.CreateDescribeInstancesRequest()
       instancesResponse, err := ecsClient.DescribeInstances(request)
       if err != nil {
           fmt.Println(err)
           return
       }
   
       for _, instance := range instancesResponse.Instances.Instance {
           // do something with instance
       }
   }

OSS Go SDK

1. 安装OSS Go SDK的RAM凭据插件。

   说明

   建议您安装最新版本的插件，更多信息，请参见原始代码。

   • 方式一：使用go.mod管理您的依赖。

     在go.mod文件中添加以下内容安装依赖包。

     require (
         github.com/aliyun/aliyun-sdk-managed-credentials-providers-go/aliyun-sdk-managed-credentials-providers/aliyun-oss-go-sdk-managed-credentials-provider vX.X.X
     )

   • 方式二：使用go get命令获取远程代码包。

     go get -u github.com/aliyun/aliyun-sdk-managed-credentials-providers-go/aliyun-sdk-managed-credentials-providers/aliyun-oss-go-sdk-managed-credentials-provider

2. 获得阿里云OSS Go SDK客户端并调用云服务。

   package sample
   
   import (
       "fmt"
       ossprovider "aliyun-oss-go-sdk-managed-credentials-provider/sdk"
   )
   
   func main() {
       secretName := "********"
       endpoint := "https://oss-cn-hangzhou.aliyuncs.com"
   
       // 获取Proxy Oss Client
       client, err := ossprovider.New(endpoint, secretName)
       if err != nil {
           fmt.Println(err)
           return
       }
   
       result, err := client.ListBuckets()
       if err != nil {
           fmt.Println(err)
           return
       }
       for _, bucket := range result.Buckets {
           //业务代码
       }
   
       // 关闭客户端来释放插件关联的资源
       client.Shutdown()
   }