Object Storage Service:Inicialización (SDK de Browser.js)

accessKeyId {String}: el AccessKey ID que se usa para autenticar las solicitudes. Un par de AccessKey es una credencial de cuenta de Alibaba Cloud que se comparte entre los productos de la nube. Con el mismo par de AccessKey puede acceder a OSS, ECS y otros productos de Alibaba Cloud. No existe un AccessKey exclusivo para OSS. Para crear un par de AccessKey, inicie sesión en la consola de Resource Access Management (RAM), cree un usuario de RAM, genere un AccessKey ID y un AccessKey secret para ese usuario, y asigne la política de acceso AliyunOSSFullAccess al usuario de RAM.

accessKeySecret {String}: el AccessKey secret que obtiene desde la consola de administración de Alibaba Cloud.

[stsToken] {String}: el token de Security Token Service que se utiliza para la autorización temporal.

[refreshSTSToken] {Function}: función que establece automáticamente los valores de stsToken, accessKeyId y accessKeySecret cuando el token de STS caduca. Esta función debe devolver un objeto que contenga stsToken, accessKeyId y accessKeySecret.

[refreshSTSTokenInterval] {number}: intervalo de renovación del token de Security Token Service, en milisegundos. Este valor debe ser menor que el periodo de caducidad del token de STS. El valor predeterminado es 300,000 milisegundos (5 minutos).

[bucket] {String}: el bucket predeterminado al que desea acceder. Si el bucket no existe, llame a la operación putBucket() para crearlo.

[endpoint] {String}: el nombre de dominio específico de la región de OSS. Este parámetro tiene mayor prioridad que el parámetro region. Según sus necesidades, puede establecer este parámetro en un endpoint público, un endpoint interno de la misma región o un nombre de dominio acelerado. Para obtener más información, consulte la lista de endpoints.

[region] {String}: la región donde se encuentra el bucket. El valor predeterminado es oss-cn-hangzhou. Utilice un valor de región específico, como oss-cn-hangzhou u oss-cn-beijing. También puede establecer este parámetro en rg-china-mainland para acceder a Anywhere Buckets en China continental, aunque se recomienda un valor de región específico para lograr un enrutamiento regional más preciso.

[internal] {Boolean}: indica si se accede a OSS mediante la red interna de Alibaba Cloud. El valor predeterminado es false. Si su servidor también se ejecuta en Alibaba Cloud, establezca este parámetro en true para reducir los costos de transferencia de datos.

[secure] {Boolean}: indica si el cliente de OSS usa el protocolo HTTPS (secure: true) o HTTP (secure: false).

[timeout] {String|Number}: el tiempo de espera para todas las operaciones, en segundos. El valor predeterminado es 60.

[cname] {Boolean}: indica si se usa un nombre de dominio personalizado para acceder a OSS. El valor predeterminado es false. Si establece este parámetro en true, debe especificar el nombre de dominio personalizado en el campo endpoint.

[isRequestPay] {Boolean}: indica si se habilita la función Requester Pays para el bucket. El valor predeterminado es false. Si establece este parámetro en true, se envía el encabezado 'x-oss-request-payer': 'requester' al servidor de OSS.

[useFetch] {Boolean}: este parámetro solo surte efecto en un entorno de navegador. El valor predeterminado es false. Si lo establece en true, los objetos se cargan mediante el método fetch; de lo contrario, se usa XMLHttpRequest.

[retryMax] {Number}: el número máximo de reintentos para una solicitud que falla por un error de red o por tiempo de espera agotado. Las operaciones putStream no admiten reintentos.

[authorizationV4] {Boolean}: indica si se usa una firma V4. El valor predeterminado es false.

Uso básico

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  stsToken: 'yourSecurityToken',
  bucket: 'your bucket name',
});

Usar un endpoint acelerado

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  stsToken: 'yourSecurityToken',
  bucket: 'your bucket name',
  endpoint: 'oss-accelerate.aliyuncs.com',
});

Usar un método de acceso personalizado

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  stsToken: 'yourSecurityToken',
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  cname: true,
  endpoint: 'your custome domain',
});

Acceder mediante un token de STS

const OSS = require('ali-oss');

const store = new OSS({
  region: 'yourRegion',
  authorizationV4: true,
  accessKeyId: 'your STS key',
  accessKeySecret: 'your STS secret',
  stsToken: 'your STS token',
  refreshSTSToken: async () => {
    const info = await fetch('you sts server');
    return {
      accessKeyId: info.accessKeyId,
      accessKeySecret: info.accessKeySecret,
      stsToken: info.stsToken,
    };
  },
  refreshSTSTokenInterval: 300000,
});

Reintentar una solicitud con un stream

for (let i = 0; i <= store.options.retryMax; i++) {
  try {
    const result = await store.putStream('<example-object>', fs.createReadStream('<example-path>'));
    console.log(result);
    break; // break if success
  } catch (e) {
    console.log(e);
  }
}

Usar una firma V4 y la opción opcional additionalHeaders

const OSS = require('ali-oss');

const store = new OSS({
  accessKeyId: 'your access key',
  accessKeySecret: 'your access secret',
  bucket: 'your bucket name',
  region: 'oss-cn-hangzhou',
  authorizationV4: true ,
  stsToken: 'yourSecurityToken',
});

try {
  const bucketInfo = await store.getBucketInfo('your bucket name');
  console.log(bucketInfo);
} catch (e) {
  console.log(e);
}

try {
  const putObjectResult = await store.put('your bucket name', 'your object name', {
    headers: {
      // The headers of this request
      header1: 'value1',
      header2: 'value2',
    },
    // The keys of the request headers to include in the V4 signature calculation. Ensure that these additional headers are included in the request headers.
    additionalHeaders: ['additional header1', 'additional header2'],
  });
  console.log(putObjectResult);
} catch (e) {
  console.log(e);
}