Alibaba Cloud SDK:Manage access credentials

The following sample code provides an example on how to call the DescribeRegions operation of Elastic Compute Service (ECS). Before you call this operation, you must install ECS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Use the default credential to initialize a Credentials client. 
  const credentialClient = new Credential.default();
  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime).then((result) => {
    console.log(JSON.stringify(result.body));
  });
}

main().catch(console.error);

The following sample code provides an example on how to call the DescribeRegions operation of ECS. Before you call this operation, you must install ECS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Use an AccessKey pair to initialize a Credentials client. 
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'access_key',
    // Specify the AccessKey ID. 
    accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
    // Specify the AccessKey secret. 
    accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET,
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime).then((response) => {
    console.log(response.body.regions);
  });
}

main().catch(console.error);

You can use the Credentials tool to read an STS token and call the API operations of Alibaba Cloud services.

The following sample code provides an example on how to call the DescribeRegions operation of ECS. Before you call this operation, you must install ECS SDK for Node.js and STS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const Sts20150401 = require('@alicloud/sts20150401');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Create an STS client and call the AssumeRole operation to obtain the STS token.
  const stsConfig = new OpenApi.Config();
  stsConfig.endpoint = 'sts.cn-hangzhou.aliyuncs.com';
  // Obtain the AccessKey ID from the environment variable.
  stsConfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID;
  // Obtain the AccessKey secret from the environment variable.
  stsConfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET;
  const stsClient = new Sts20150401.default(stsConfig);
  const assumeRoleRequest = Sts20150401.AssumeRoleRequest;
  // Specify the validity period of the STS token.
  assumeRoleRequest.durationSeconds = 3600;
  // Specify the Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to assume by specifying the ALIBABA_CLOUD_ROLE_ARN environment variable. Example: acs:ram::123456789012****:role/adminrole.
  assumeRoleRequest.roleArn = '<RoleArn>';
  // Specify the role session name by specifying the ALIBABA_CLOUD_ROLE_SESSION_NAME environment variable.
  assumeRoleRequest.roleSessionName = '<RoleSessionName>';
  // Specify the policies that you want to attach to the RAM role.
  // assumeRoleRequest.policy = "";
  const assumeRoleResponsePromise = stsClient.assumeRole(assumeRoleRequest);
  const assumeRoleResponseBodyCredentials = (await assumeRoleResponsePromise).body.credentials;

  // Use an STS token to initialize a Credentials client. 
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'sts',
    accessKeyId: assumeRoleResponseBodyCredentials.accessKeyId,
    accessKeySecret: assumeRoleResponseBodyCredentials.accessKeySecret,
    securityToken: assumeRoleResponseBodyCredentials.securityToken,
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime).then((response) => {
    console.log(response.body.regions);
  });
}

main().catch(console.error);

The following sample code provides an example on how to call the DescribeRegions operation of ECS. Before you call this operation, you must install ECS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Use an AccessKey pair and a RAM role to initialize a Credentials client. 
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'ram_role_arn',
    // Specify the AccessKey ID. 
    accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
    // Specify the AccessKey secret. 
    accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET,
    // Specify the ARN of the RAM role that you want to assume by specifying the ALIBABA_CLOUD_ROLE_ARN environment variable. Example: acs:ram::123456789012****:role/adminrole.
    roleArn: '<RoleArn>',
    // Specify the role session name by specifying the ALIBABA_CLOUD_ROLE_SESSION_NAME environment variable.
    roleSessionName: '<RoleSessionName>',
    // Optional. Specify limited permissions for the RAM role. Example: {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}.
    policy: '<Policy>',
    roleSessionExpiration: 3600,
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  const response = ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime);
  console.log((await response).body.regions);
}

main().catch(console.error);

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Use the RAM role of an ECS instance to initialize a Credentials client. 
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'ecs_ram_role',
    // Optional. Specify the name of the RAM role of the ECS instance by specifying the ALIBABA_CLOUD_ECS_METADATA environment variable. If you do not specify this parameter, its value is automatically obtained. To reduce the number of requests, we recommend that you specify this parameter.
    roleName: '<RoleName>',
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  const response = ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime);
  console.log((await response).body.regions);
}

main().catch(console.error);

The following sample code provides an example on how to call the DescribeRegions operation of ECS. Before you call this operation, you must install ECS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'oidc_role_arn',
    // Specify the ARN of the RAM role that you want to assume by specifying the ALIBABA_CLOUD_ROLE_ARN environment variable.
    roleArn: '<RoleArn>',
    // Specify the ARN of the OIDC IdP by specifying the ALIBABA_CLOUD_OIDC_PROVIDER_ARN environment variable.
    oidcProviderArn: '<OidcProviderArn>',
    // Specify the path of the OIDC token file by specifying the ALIBABA_CLOUD_OIDC_TOKEN_FILE environment variable.
    oidcTokenFilePath: '<OidcTokenFilePath>',
    // Specify the role session name by specifying the ALIBABA_CLOUD_ROLE_SESSION_NAME environment variable.
    roleSessionName: '<RoleSessionName>',
    // Optional. Specify limited permissions for the RAM role. Example: {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}.
    policy: '<Policy>',
    // Specify the validity period of the session.
    roleSessionExpiration: 3600,
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpoint = 'ecs.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  const response = ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime);
  console.log((await response).body.regions);
}

main().catch(console.error);

To call the API operations of Alibaba Cloud services, you can specify a local or remote URI for credentials and use the Credentials tool to obtain and automatically update an STS token based on the local or remote URI.

To call the operations of an Alibaba Cloud service, you must install dependencies for the Alibaba Cloud service. The following sample code provides an example on how to call the DescribeRegions operation of ECS. Before you call this operation, you must install ECS SDK for Node.js.

const Ecs20140526 = require('@alicloud/ecs20140526');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Credential = require('@alicloud/credentials');

async function main() {
  // Use a credential URI to initialize a Credentials client. 
  const credentialsConfig = new Credential.Config({
    // Specify the type of the credential. 
    type: 'credentials_uri',
    // Specify the URI of the credential in the http://local_or_remote_uri/ format by specifying the ALIBABA_CLOUD_CREDENTIALS_URI environment variable.
    credentialsURI: '<CredentialsUri>',
  });
  const credentialClient = new Credential.default(credentialsConfig);

  const ecsConfig = new OpenApi.Config();
  // Specify the endpoint of ECS. 
  ecsConfig.endpointType = 'ecs.aliyuncs.com';
  // Use the SDK Credentials package to configure a credential. 
  ecsConfig.credential = credentialClient;
  // Initialize the ECS SDK client.
  const ecsClient = new Ecs20140526.default(ecsConfig);
  // Initialize the request to call the DescribeRegions operation. 
  const describeRegionsRequest = new Ecs20140526.DescribeRegionsRequest();
  // Initialize the runtime configurations. 
  const runtime = new Util.RuntimeOptions();
  // Call the DescribeRegions operation and obtain a response. 
  const response = ecsClient.describeRegionsWithOptions(describeRegionsRequest, runtime);
  console.log((await response).body.regions);
}

main().catch(console.error);