Key Management Service:RAM secret plug-in

You can import the RAM credential plug-in into your project using Maven.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-tea-openapi-sdk-managed-credentials-provider</artifactId>
    <version>[1.3.5,]</version>
</dependency>

Retrieve an Alibaba Cloud SDK for Java client and call an Alibaba Cloud service.

The following example shows how to call the ECS DescribeInstances operation.

1. Add the ecs20140526 dependency for Elastic Compute Service.

   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>ecs20140526</artifactId>
       <version>7.1.0</version>
   </dependency>

2. Call the DescribeInstances operation.

   import com.aliyun.ecs20140526.Client;
   import com.aliyun.ecs20140526.models.DescribeInstancesResponse;
   import com.aliyun.kms.secretsmanager.plugin.tea.openapi.ProxyClientCreator;
   import com.google.gson.Gson;
   
   public class AliyunTeaOpenApiProviderSample {
   
       public static void main(String[] args) throws Exception {
           // Step 1: Specify the name of the managed secret (the secret name created in KMS).
           String secretName = "your-secret-name";
   
           /*
             If the application cannot read the default configuration file (managed_credentials_providers.properties) from the classpath and executable JAR package,
             or to customize the configuration file name, you can call the following code to set a custom configuration file. The file is read in the following order:
             1. If "your-config-name" is an absolute path with a filename, the file at that absolute path is read.
             2. If "your-config-name" is only a filename, the file is first read from the classpath, and then from the executable JAR package.
           */
           //ConfigLoader.setConfigName("your-config-name");
   
           // Step 2: Configure the OpenAPI client.
           com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
           config.endpoint = "your-product-endpoint"; // Replace with the actual service endpoint.
   
           // Step 3: Create a client instance.
           Client client = ProxyClientCreator.createClient(config, Client.class, secretName);
   
           // Step 4: Call the Alibaba Cloud service API.
           com.aliyun.ecs20140526.models.DescribeInstancesRequest request = new com.aliyun.ecs20140526.models.DescribeInstancesRequest();
           request.setRegionId("cn-hangzhou"); // Set the region ID.
           DescribeInstancesResponse response = client.describeInstances(request);
   
           // Step 5: Print the result.
           System.out.println(new Gson().toJson(response.getBody()));
       }
   }

Use Maven to import the RAM credential plug-in into 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>

Retrieve an Alibaba Cloud SDK for Java client and call an Alibaba Cloud service.

The following example shows how to call the ECS DescribeInstanceStatus operation.

1. Add the aliyun-java-sdk-ecs dependency for Elastic Compute Service.

   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>aliyun-java-sdk-ecs</artifactId>
     <version>5.11.20</version>
   </dependency>

2. Call the DescribeInstanceStatus operation.

   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 read the default configuration file (managed_credentials_providers.properties) from the classpath and executable JAR package,
             or to customize the configuration file name, you can call the following code to set a custom configuration file. The file is read in the following order:
             1. If "your-config-name" is an absolute path with a filename, the file at that absolute path is read.
             2. If "your-config-name" is only a filename, the file is first read from the classpath, and then from the executable JAR package.
           */
           //ConfigLoader.setConfigName("your-config-name");
           
           // 1. Get the ACSClient using aliyun-java-sdk-managed-credentials-provider.
           IAcsClient client = null;
           try {
               client = new ProxyAcsClient("<the regionId of ECS>", secretName);
           } catch (ClientException e) {
                e.printStackTrace();
            }
           // 2. Call the OpenAPI of ECS to implement business features.
           DescribeInstanceStatusRequest request = new DescribeInstanceStatusRequest();
           DescribeInstanceStatusResponse response;
           try {
                response = client.getAcsResponse(request);
           } catch (ServerException e) {
                e.printStackTrace();
            } catch (ClientException e) {
                e.printStackTrace();
            }
           // 3. Call the following method to shut down the client and release the resources associated with the plug-in. 
           client.shutdown();
       }
   }

You can import the RAM credential plug-in into your project using Maven.

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

Retrieve an OSS SDK for Java client and call an Alibaba Cloud service.

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 read the default configuration file (managed_credentials_providers.properties) from the classpath and executable JAR package,
          or to customize the configuration file name, you can call the following code to set a custom configuration file. The file is read in the following order:
          1. If "your-config-name" is an absolute path with a filename, the file at that absolute path is read.
          2. If "your-config-name" is only a filename, the file is first read from the classpath, and then from the executable JAR package.
        */
        //ConfigLoader.setConfigName("your-config-name");

        // Get the OSS client.
        OSS ossClient = new ProxyOSSClientBuilder().build(endpoint, secretName);


        // The following is the business code: Call the Alibaba Cloud OSS service to implement business features.
        List<Bucket> buckets = ossClient.listBuckets();
        for (Bucket bucket : buckets) {
            if (bucket != null) {
                // ...
            }
        }

        // Call the following method to shut down the client and release the resources associated with the plug-in. 
        ossClient.shutdown();
    }

}

Run the pip command to use the RAM credential plug-in in your project.

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

Retrieve an Alibaba Cloud SDK for Python client and call an Alibaba Cloud service.

from aliyun_sdk_secretsmanager_sdk_core_plugin.proxy_acs_client import ProxyAcsClient

   region="cn-hangzhou"
   secretName="******"

   # 1. Get the ACSClient.
   client = ProxyAcsClient(region_id=region, secret_name=secretName )

   # 2. Business code: Use the client to call Alibaba Cloud services without code changes.
   ...

   # 3. Call the following method to shut down the client and release the resources associated with the plug-in.
   client.shutdown()

You can run the pip command to use the RAM credential plug-in in your project.

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

Retrieve an Alibaba Cloud OSS SDK for Python client and call an Alibaba 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()

Install the RAM credential plug-in for the Alibaba Cloud SDK for Go.

• Method 1: Use go.mod to manage your 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: Use the go get command to retrieve 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

Retrieve a client for the Alibaba Cloud SDK for Go and call an Alibaba Cloud service.

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

Install the RAM credential plug-in for the OSS SDK for Go.

• Method 1: Use go.mod to manage your 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: Use the go get command to retrieve 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

Retrieve a client for the Alibaba Cloud OSS SDK for Go and call an Alibaba 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"

    // Get the 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 {
        // Business code
    }

    // Shut down the client to release the resources associated with the plug-in.
    client.Shutdown()
}