Key Management Service:RAM secret plug-in

Java

Alibaba Cloud SDK V1.0 for Java

1. Add the RAM secret plug-in as a Maven dependency to your project.

   <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>

   Note

   We recommend that you install the latest version of the plug-in. For more information, visit Source code.

2. Create a client of Alibaba Cloud SDK for Java and call a cloud service.

   The following sample code provides an example on how to call the DescribeInstanceStatus operation of ECS:

   When you run the following sample code, add the aliyun-java-sdk-ecs dependency of ECS to the pom.xml file.

   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="******";
           /*
             If the application cannot set the default configuration file (managed_credentials_providers.properties) to read from the classpath and executable jar package, 
             or if you want to specify a custom file name, you can use the following code to configure a custom file:
             1. If your-config-name is set to a value in the Absolute path + File name format, the configuration file in the absolute path is read.
             2. If your-config-name is set to a file name, the configuration file in classpath is read and then the configuration file in the executable JAR package is read.
           */
           //ConfigLoader.setConfigName("your-config-name");
           
           // 1. Create a client.
           IAcsClient client = null;
           try {
               client = new ProxyAcsClient("<the regionId of ECS>", secretName);
           } catch (ClientException e) {
                e.printStackTrace();
            }
           // 2. Call an API operation of ECS to implement business functionality.
           DescribeInstanceStatusRequest request = new DescribeInstanceStatusRequest();
           DescribeInstanceStatusResponse response;
           try {
                response = client.getAcsResponse(request);
           } catch (ServerException e) {
                e.printStackTrace();
            } catch (ClientException e) {
                e.printStackTrace();
            }
           // 3. Shut down the client to release plug-in-related resources. 
           client.shutdown();
       }
   }

OSS SDK for Java

1. Add the RAM secret plug-in as a Maven dependency to your project.

   <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>

   Note

   We recommend that you install the latest version of the plug-in. For more information, visit Source code.

2. Create a client of Object Storage Service (OSS) SDK for Java and call a cloud service.

   The following sample code provides an example on how to call the listBuckets operation of OSS:

   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";
   
           /*
             If the application cannot set the default configuration file (managed_credentials_providers.properties) to read from the classpath and executable jar package, 
             or if you want to specify a custom file name, you can use the following code to configure a custom file:
             1. If your-config-name is set to a value in the Absolute path + File name format, the configuration file in the absolute path is read.
             2. If your-config-name is set to a file name, the configuration file in classpath is read and then the configuration file in the executable JAR package is read.
           */
           //ConfigLoader.setConfigName("your-config-name");
   
           // Create a client.
           OSS ossClient = new ProxyOSSClientBuilder().build(endpoint, secretName);
   
   
           // Call the listBuckets operation.
           List<Bucket> buckets = ossClient.listBuckets();
           for (Bucket bucket : buckets) {
               if (bucket != null) {
                   // ...
               }
           }
   
           // Shut down the client to release plug-in-related resources. 
           ossClient.shutdown();
       }
   
   }

Python

Alibaba Cloud SDK V1.0 for Python

1. Run the pip command to install the RAM secret plug-in.

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

   Note

   Make sure that the version of the RAM secret plug-in is 0.1.0 or later. For more information, visit Source code.

2. Create a client of Alibaba Cloud SDK for Python and call a cloud service.

   from aliyun_sdk_secretsmanager_sdk_core_plugin.proxy_acs_client import ProxyAcsClient
   
      region="cn-hangzhou"
      secretName="******"
   
      # 1. Create an ACSClient instance.
      client = ProxyAcsClient(region_id=region, secret_name=secretName )
   
      # 2. Use the instance to call a cloud service. You do not need to modify the business code. 
      ...
   
      # 3. Disable the instance to release plug-in-related resources.
      client.shutdown()

OSS SDK for Python

1. Run the pip command to install the RAM secret plug-in.

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

   Note

   Make sure that the version of the RAM secret plug-in is 0.1.0 or later. For more information, visit Source code.

2. Create a client of OSS SDK for Python and call a cloud service.

   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

Alibaba Cloud SDK V1.0 for Go

1. Install the RAM secret plug-in.

   Note

   We recommend that you install the latest version of the plug-in. For more information, visit Source code.

   • Method 1: Use the go.mod file to manage dependencies.

     Add the following content to the go.mod file to install the dependency package:

     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
     )

   • Method 2: Run the go get command to obtain the remote code package.

     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. Create a client of Alibaba Cloud SDK for Go and call a cloud service.

   The following sample code provides an example on how to call the DescribeInstances operation of ECS:

   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 SDK for Go

1. Install the RAM secret plug-in.

   Note

   We recommend that you install the latest version of the plug-in. For more information, visit Source code.

   • Method 1: Use the go.mod file to manage dependencies.

     Add the following content to the go.mod file to install the dependency package:

     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
     )

   • Method 2: Run the go get command to obtain the remote code package.

     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. Create a client of OSS SDK for Go and call a cloud service.

   package sample
   
   import (
       "fmt"
       ossprovider "aliyun-oss-go-sdk-managed-credentials-provider/sdk"
   )
   
   func main() {
       secretName := "********"
       endpoint := "https://oss-cn-hangzhou.aliyuncs.com"
   
       // Create a 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 {
           // The business code.
       }
   
       // Shut down the proxy OSS client to release plug-in-related resources.
       client.Shutdown()
   }