如何为OSS Harmony SDK配置访问凭证

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

使用Harmony SDK发起OSS请求,您需要配置访问凭证。阿里云服务会通过访问凭证验证您的身份信息和访问权限。您可以根据使用场景对认证和授权的要求,选择不同类型的访问凭证。

注意事项

常用配置示例

使用STS临时访问凭证(推荐)

如果您的应用程序需要临时访问OSS,您可以使用通过STS服务获取的临时身份凭证(Access Key ID、Access Key SecretSecurity Token)初始化客户端。

重要

以下示例代码展示了如何对访问凭据直接进行硬编码,显式设置要使用的临时访问密钥。

import Client from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为STS临时访问凭证的Access Key ID, 非阿里云账号AccessKey ID和Access
  // 请注意区分STS服务获取的Access Key ID是以STS开头,如下所示
  accessKeyId: 'STS.****************',
  // 请替换为STS临时访问凭证的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 请替换为STS临时访问凭证的Security Token
  securityToken: 'yourSecurityToken',
  // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 使用创建的OSS客户端实例client发起OSS请求

使用RAM用户的AK

如果您的应用程序部署运行在安全、稳定且不易受外部攻击的环境中,需要长期访问您的OSS,且不能频繁轮转凭证时,您可以使用阿里云主账号或RAM用户的AK(Access Key ID、Access Key Secret)初始化客户端。

重要
  • 如需创建RAM用户的AK,请直接访问创建AccessKey。RAM用户的Access Key ID、Access Key Secret信息仅在创建时显示,请及时保存,如若遗忘请考虑创建新的AK进行轮换。

  • 阿里云账号拥有资源的全部权限,AK一旦泄露,会给系统带来巨大风险,不建议使用。推荐使用最小化授权的RAM用户的AK。

以下示例代码展示了如何对访问凭据直接进行硬编码,显式设置要使用的访问密钥。

警告

请勿将RAM用户的访问凭据嵌入到生产环境的应用程序中,此方法仅用于测试目的。

import Client from '@aliyun/oss';

// 创建OSS客户端实例
const client = new Client({
  // 请替换为RAM用户的Access Key ID
  accessKeyId: 'yourAccessKeyID',
  // 请替换为RAM用户的Access Key Secret
  accessKeySecret: 'yourAccessKeySecret',
  // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou
  region: 'oss-cn-hangzhou',
});

// 使用创建的OSS客户端实例client发起OSS请求

常见问题

在使用通过STS服务获取的临时身份凭证去初始化凭证提供者时,误使用RAM用户的AK

当您使用通过STS服务获取的临时身份凭证(Access Key ID、Access Key SecretSecurity Token)初始化访问凭证时,请勿混淆STS服务返回的AKRAM用户的AK,STS对应的AK是以STS开头,示例如下:

image

如何查看RAM用户的AK?是否可以查看旧的AccessKey Secret?

  1. 如需查看RAM用户的AK,请直接参考文档查看RAM用户的AccessKey信息

  2. RAM用户的AccessKey Secret仅在创建时显示,之后无法查看,若您已经遗忘了的话无法找回。您可以直接访问RAM控制台选择具体用户,并创建新的AccessKey进行轮换。详细请参见创建AccessKey

使用RAM用户的AK进行上传文件时,报错AccessDenied如何排查?

上传文件时出现AccessDenied的问题,通常是因为使用了错误的AK信息或没有给RAM用户添加上传文件的权限,您可以按照以下步骤检查:

  1. 检查您使用的RAM用户的AK是否正确,请直接参考文档查看RAM用户的AccessKey信息

  2. RAM用户的AccessKey Secret仅在创建时显示,之后无法查看,若您已经遗忘了的话无法找回。您可以直接访问RAM控制台选择具体用户,并创建新的AccessKey进行轮换。详细请参见创建AccessKey

  3. 登录RAM控制台选择具体用户,给RAM用户添加上传文件到OSS的权限。

在使用外网Endpoint访问OSS时,报错无法连接该如何排查?

出现外网Endpoint无法连接的问题,通常是因为使用了错误的Endpoint地址或Bucket所在地域与请求的Endpoint不匹配。请您按照以下步骤检查:

  1. 确认Bucket所在地域:登录阿里云控制台,找到您的Bucket,确认其所在地域。

  2. 使用正确的Endpoint:根据Bucket所在地域,使用对应的外网Endpoint。例如,如果Bucket位于华东1(杭州),则应使用oss-cn-hangzhou.aliyuncs.com。各地域的Endpoint信息请参见OSS地域和访问域名

  3. 检查网络连接:确保您的网络环境可以正常访问互联网,避免因网络问题导致连接失败。

如果遇到报错问题该如何查询具体的错误类型?

关于错误类型的查询,OSS文档提供了EC错误码供您参阅,例如关于认证方面的常见报错问题,请参见02-AUTH